結果は XML または JSON 形式で返されますが、JSON がデフォルトの選択です。リクエストパラメータ Format
を指定することで、XML スキーマに切り替えることができます。詳細については、コモンパラメーターを参照してください。
注:API ドキュメントの応答例には、読みやすくするために改行や字下げがあります。実際の応答結果はフォーマットされません。
レスポンスの成功例
すべての成功した応答は、 RequestId
要素内のリクエスト ID と他の API 特有の応答パラメータを持ちます。成功応答の HTTP ステータスコードは 2XX です。
XML
形式
<?xml version="1.0" encoding="UTF-8"?> <!--Result root node-->
<ActionResponse> <!--Response request tag-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F223</RequestId> <!--Response result data-->
</ActionResponse>
JSON
形式
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F223" /* Response result data */
}
エラーレスポンスの例
すべてのエラーレスポンスは、 RequestId
エレメントのリクエスト ID と HostId
エレメントのアクセスエンドポイント、エラーコード、およびエラーメッセージで構成されます。エラーレスポンスの HTTP ステータスコードは 4xx または 5xx です。
API 固有のエラーコードまたはコモンエラーコードに従って例外を修正し、リクエストを再試行できます。また、チケットを開き、HostId
や RequestId
などの追加情報を入力して、当社の技術サポートを受けることができます。
XML
形式
<?xml version="1.0" encoding="UTF-8"?> <!--Result root node-->
<Error>
<RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--Request ID-->
<HostId>ess.aliyuncs.com</HostId> <!--Endpoint-->
<Code>ServiceUnavailable </Code> <!--Error code-->
<Message>The request has failed due to a temporary failure of the server.</Message> <!--Error message-->
</Error>
JSON
形式
{
"RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* Request ID */
"HostId": "ess.aliyuncs.com", /* Endpoint */
"Code": "ServiceUnavailable", /* Error code */
"Message": "The request has failed due to a temporary failure of the server." /* Error message */
}
一般的なエラーコード
エラーコード | エラーメッセージ | HTTP ステータスコード | 意味 |
---|---|---|---|
InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | 400 | 指定された AccessKey は存在しません。 |
InvalidParameter | The specified value of parameter <parameter name> is not valid. | 400 | 指定されたパラメータは無効です。 |
MissingParameter | The input parameter <parameter name> that is mandatory for processing this request is not supplied | 400 | 必要なパラメーターを指定する必要があります。 |
NoSuchVersion | The specified version does not exist. | 400 | 指定された API バージョンは存在しません。 |
ResourceNotAvailable | Resource you requested is not available in this region or zone. | 400 | 指定されたリージョンで ESS サービスを使用できません。 |
Throttling | Request was denied due to request throttling. | 400 | あなたは短時間で頻繁に頻繁にリクエストしました。後でもう一度お試しください。 |
UnsupportedOperation | The specified action is not supported. | 400 | 指定された API を呼び出すことができません。 |
Forbidden | Users are not authorized to operate on the specified resource. | 403 | 指定した操作を実行することはできません。 |
Forbidden.RiskControl | This operation is forbidden by Aliyun Risk Control system. | 403 | 指定されたアクションはリスク管理下にあります。 |
Forbidden.Unsubscribed | Do not have permission to access this API. | 403 | この API を呼び出す前に、ESS サービスを使用可能にする必要があります。 |
SignatureDoesNotMatch | The signature we calculated does not match the one you provided. | 403 | 私たちによって計算された署名は、あなたが提供する署名とは異なります。 |
InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部エラー。 |
ServiceUnavailable | The request has failed due to a temporary failure of the server. | 503 | サーバーはあなたのリクエスト応答できません。後でもう一度お試しください。 |