PDS が API リクエストを処理できない場合、エラーレスポンスを返し、障害を特定します。本トピックでは、PDS がエラーレスポンスに使用する形式を説明し、PDS サービスが返す一般的なエラーコードを一覧で示します。
失敗したリクエストのトラブルシューティングを行うには、まずどのレイヤーがエラーを報告したかを特定し、次にエラーコードを確認します。
CodeとMessageを含む JSON レスポンスボディは、PDS サービスがエラーを報告したことを示します。一般的なエラーコードでCodeの値を確認してください。JSON エラーボディがなく、
x-ca-error-codeおよびx-ca-error-messageヘッダーを持つレスポンスは、ゲートウェイレイヤーがエラーを報告したことを示します。各ヘッダーの意味については、ゲートウェイエラーレスポンスをご参照ください。x-ca-request-idヘッダーは両方の種類のエラーレスポンスで返されるため、これを使用して 2 つを区別することはできません。
エラーレスポンスの形式
サービスエラーレスポンス
PDS がリクエストを処理する際にエラーが発生した場合、PDS は次の形式でエラーレスポンスを返します。
{
"Message": "The input parameter file_id is not valid.",
"RequestId": "772328B2-E5F4-453C-9C23-CCCCCCCC",
"Code": "InvalidParameter"
}レスポンスの HTTP ステータスコードは、エラーによって異なります。レスポンスボディには次のフィールドが含まれます。
Code— エラーコード。エラーの種類を示します。Message— エラーメッセージ。エラーの原因と解決策を示します。RequestId— リクエストの一意の ID。API オペレーションを呼び出すと、この値はx-ca-request-idレスポンスヘッダーで返されます。
ゲートウェイエラーレスポンス
一部のシナリオでは、ゲートウェイレイヤーがエラーを報告します。この場合、エラーコードとエラーメッセージは、JSON レスポンスボディではなく、レスポンスヘッダーで返されます。
x-ca-error-code: D504TO
x-ca-error-message: timeout
x-ca-request-id: 772328B1-E5F4-453C-9C23-CCCCCCCCレスポンスには次のヘッダーが含まれます。
x-ca-error-code— エラーコード。エラーの種類を示します。x-ca-error-message— エラーメッセージ。エラーの原因と解決策を示します。x-ca-request-id— リクエストの一意の ID。
一般的なエラーコード
次の表は、PDS サービスがエラーレスポンスボディの Code フィールドで返す一般的なエラーコードを、報告する問題の種類別にグループ化して一覧にしたものです。これらのエラーコードは、発生する可能性のあるエラーのほとんどを網羅しています。ゲートウェイレイヤーが x-ca-error-code ヘッダーで返すエラーコードは、本トピックには記載されていません。表を読む際は、次の点に注意してください。
PDS は中括弧内の各プレースホルダーを特定の値に置き換えます。
{parameter_name}はフィールド名に対応し、{resource_name}はリソースタイプに対応します。HTTP ステータスコード 列には、レスポンスの HTTP ステータスコードが表示されます。
Message 列の情報は、実際のレスポンスとわずかに異なる場合があります。通常、より具体的なエラー情報を示すためです。
パラメーターとリクエストのエラー
次の表は、リクエストのパラメーター、ヘッダー、ボディ、または HTTP メソッドに問題があることを示す PDS エラーコードを一覧にしたものです。
HTTP ステータスコード | Code | Message |
400 |
| The input parameter {parameter_name} is not valid. |
400 |
| The input parameter {parameter_name} is empty. |
400 |
| The input parameter {parameter_name} has an invalid format. |
400 |
| The input parameter {parameter_name} is not in a valid JSON format. |
400 |
| The input parameter {parameter_name} is not supported. |
400 |
| The input parameter {parameter_name} is missing. |
400 |
| The input parameter {parameter_name} does not match. |
400 |
| The input parameter {parameter_name} does not match the limitation. |
400 |
| The input parameter {parameter_name} is expired. |
400 |
| The header {header_name} is not valid. |
400 |
| The input parameter relative_path is nested inside another relative_path: {path}. |
400 |
| Failed to read the request body. |
405 |
| The HTTP method of the request is not supported for this resource. See the API documentation for the supported methods. |
リソースと状態のエラー
次の表は、ターゲットリソースまたはリソースの現在の状態に問題があることを示す PDS エラーコードを一覧にしたものです。
HTTP ステータスコード | Code | Message |
400 |
| The resource {resource_name} has exceeded the limit. |
400 |
| The resource {resource_name} is not valid. |
400 |
| The resource {resource_name} is not supported. |
400 |
| The resource {resource_name} is not empty. |
400 |
| The resource {resource_name} already exists. |
400 |
| Multiple objects with the same sha1 value were found. |
400 |
| The current status does not support this operation. |
400 |
| The user operation is not valid. Try again later. |
404 |
| The resource {resource_name} is empty. |
404 |
| The resource {resource_name} cannot be found. |
認証、権限、およびアカウントのエラー
次の表は、認証情報、権限、またはアカウントの問題が原因でリクエストが拒否されたことを示す PDS エラーコードを一覧にしたものです。
HTTP ステータスコード | Code | Message |
400 |
| SignatureDoesNotMatch. |
403 |
| The user is not authorized to operate on the specified API operations. |
403 |
| No permission to access the resource {resource_name}. |
403 |
| The specified account does not exist. |
403 |
| The specified account is in debt. |
403 |
| Cannot access the specified service role. |
403 |
| This operation is forbidden by the Alibaba Cloud RiskControl system. |
403 |
| This operation is forbidden for a file in the recycle bin. |
スロットリングとサーバーのエラー
次の表は、PDS がリクエストをスロットリングしたか、完了できなかったことを示す PDS エラーコードを一覧にしたものです。
HTTP ステータスコード | Code | Message |
429 |
| The operation is blocked due to throttling control. |
500 |
| The request failed due to an unknown error. Try again later. |
503 |
| The request failed due to a temporary failure of the server. Try again later. |
お問い合わせ
すべての PDS エラーレスポンスは、失敗したリクエストを特定します。両方の種類のエラーレスポンスは、x-ca-request-id ヘッダーで ID を返し、サービスエラーレスポンスは、レスポンスボディの RequestId フィールドでも ID を返します。解決できないエラーを報告する前に、この ID を記録してください。