> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apigo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# エラーコード

> API 内のエラー コード ガイド リクエストの失敗を素早く絞り込むためのガイド。

エラー応答は主に、HTTP ステータス、`error.type`、`error.code`、`error.message`、および `X-Request-Id` によって記述されます。

## エラー応答形状

* HTTP ステータス: リクエストの最終的な失敗クラス。
* `X-Request-Id`: トレース ID を要求します。クライアントがそれを送信しない場合、ゲートウェイはそれを生成し、失敗時にそれを返そうとします。
* `error.message`: 呼び出し側の人が判読できるエラーの説明。
* `error.type`: エラーの種類。現在、安定した MaaS ゲートウェイのエラーには `invalid_request_error` が使用されます。アップストリーム プラットフォームのエラーでは、異なる値が使用される場合があります。
* `error.code`: エラーコード。 MaaS ゲートウェイのエラーには安定したコードが使用されます。アップストリーム プラットフォームのエラーでは、このフィールドが省略される場合があります。

```json Example response theme={null}
{
  "error": {
    "message": "upstream provider credentials unavailable",
    "type": "invalid_request_error",
    "code": "missing_upstream_key"
  }
}
```

## エラーの原因

### MaaSゲートウェイ

| ZXプロテクト0ZX | HTTP ステータス | ZXプロテクト0ZX | ZXプロテクト0ZX | Meaning                                                         |
| ---------- | ---------- | ---------- | ---------- | --------------------------------------------------------------- |
| ZXプロテクト0ZX | `502`      | ZXプロテクト0ZX | ZXプロテクト0ZX | アップストリーム サービスは現在利用できません。プラットフォーム管理者にプロバイダーの資格情報を確認するよう依頼してください。 |
| ZXプロテクト0ZX | `502`      | ZXプロテクト0ZX | ZXプロテクト0ZX | アップストリーム サービス構成が無効であるため、リクエストを完了できません。                          |
| ZXプロテクト0ZX | `502`      | ZXプロテクト0ZX | ZXプロテクト0ZX | アップストリーム サービスの資格情報が使用できないため、リクエストを完了できません。                      |

### 上流プラットフォームのエラー

一部のリクエストは、上流のプラットフォームから直接エラーを返す場合があります。その場合は、実際の HTTP ステータスと返された `error` オブジェクトを信頼してください。

* HTTP ステータス: 返されたステータスをそのまま使用します。
* 応答本文: 通常、プラットフォームの `error.type`、`error.code`、および `error.message` が含まれます。
* `X-Request-Id`: サポートとログ検索のために保管してください。
* ドキュメントの境界: すべてのアップストリーム `type` または `code` 値を安定した MaaS ゲートウェイ エラー コードとして扱わないでください。

```json Platform passthrough example theme={null}
{
  "error": {
    "message": "daily credits exhausted",
    "type": "insufficient_quota"
  }
}
```

この `402` の例は、クレジットまたは残高が使い果たされたことを意味します。これはアップストリーム プラットフォームからのものであり、安定した MaaS ゲートウェイ エラー コード セットの一部ではありません。

## 推奨されるデバッグ順序

1. まず HTTP ステータスを確認して、障害が安定した MaaS ゲートウェイのエラーであるか、アップストリーム プラットフォームのエラーであるかを判断します。
2. `X-Request-Id` はサポートとログ検索のために保管してください。
3. `error.code` が `missing_upstream_key`、`invalid_upstream_key_info`、または `masked_upstream_key` の場合は、プラットフォーム管理者に問い合わせて、サービス構成の問題を解決してください。
4. 応答がアップストリーム プラットフォーム エラーである場合は、`error.type`、`error.code`、および `error.message` を使用して、クォータ、認証、またはプラットフォーム ポリシーの問題を診断します。