エラーと終了コード
終了コード
| 終了コード | 内容 |
|---|---|
0 | 成功(一覧が 0 件で (なし) と出したときも含む) |
1 | 失敗 |
原因は終了コードでは分けません。メッセージの HTTP ステータスと、--json のときの code で見分けてください。
テキストのエラー
エラーのメッセージは標準エラー出力に出します。サーバーが HTTP のステータスを返した場合は、 エラー(403): … のように番号を付けます。 通信エラーやオプションの指定ミスなど、HTTP のステータスが無い場合は番号を付けません。
text
$ tagru posts --workspace ws-zzzz
エラー(403): API の呼び出しに失敗しました(HTTP 403 Not a member of workspace)。text
$ tagru posts
ログインしていません。`tagru login --target prod` を実行してください。JSON のエラー(--json)
--json のときは、次の形の JSON を 1 行で標準エラー出力に出します。 status は HTTP のステータスで、無い場合は null です。
json
{ "error": { "status": 403, "code": "forbidden", "message": "..." } }text
$ tagru posts --limit 101 --json
{"error":{"status":null,"code":"usage_error","message":"--limit の上限は 100 です(指定値: 101)。サーバーの負荷を抑えるため、一度に取得できる件数を制限しています。"}}| code | 内容 |
|---|---|
usage_error | オプションの指定ミス |
login_failed | ログインを完了できなかった |
login_required | ログインしていない・ログインの有効期限切れ |
forbidden | 権限がない(CLI からは使えない操作・参加していないワークスペースを含む) |
not_found | 見つからない |
network_error | サーバーに接続できない・タイムアウト |
api_error | その他のサーバーのエラー |
unexpected_error | 予期しないエラー |
よくあるエラー
| メッセージ | 対処 |
|---|---|
ログインしていません。… | tagru login でログインする |
エラー(403): この操作には書き込みの権限がありません。… | 読み取りだけのログインです。tagru login --write でログインし直し、同意画面で書き込みを許可する |
エラー(403): … | 参加していないワークスペースを指定していないか、tagru use で確かめる |
エラー(403): 広告管理を利用できません… | そのワークスペース(個人)では広告管理が使えません(tagru ads) |
エラー(403): このクライアント(サービス)の広告を見る権限がありません。… | tagru ads services で見られるサービスを確かめる |
--limit の上限は 100 です… | --limit を 1〜100 にする |
接続先 test には既定の URL がありません。… | 環境変数 TAGRU_API_URL を指定する(接続先と設定) |