API 応答は HTTP 応答形式を使用します。2xx 状態コードは呼び出しの成功を示し、4xx または 5xx 状態コードは呼び出しの失敗を示します。このトピックのサンプル応答は、読みやすいようにフォーマットされています。実際の応答は、改行やインデントでフォーマットされていません。
サンプルの成功応答
XML 形式
<?xml version="1.0" encoding="UTF-8"?>
<!--結果ルートノード-->
<Interface Name+Response>
<!--リクエストタグを返す-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--結果データを返す-->
</Interface Name+Response>JSON 形式
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}サンプルのエラー応答
API 操作の呼び出し時にエラーが発生した場合、結果データは返されません。返されたエラーコードと 一般的なエラー に基づいてエラーをトラブルシューティングできます。
API 操作の呼び出し時にエラーが発生した場合、応答には HTTP 状態コード、エラーコード、エラーメッセージ、およびリクエストの ID が返されます。エラーコードとエラーメッセージに基づいてエラーをトラブルシューティングできない場合は、リクエストの ID を Alibaba Cloud テクニカルサポートに提供して、リクエストログを特定できます。次のサンプル応答は、必須のタイムスタンプが提供されていない場合に発生するエラーを示しています。
XML 形式
<KMS>
<HttpStatus>400</HttpStatus>
<Code>IllegalTimestamp</Code>
<Message>The input parameter "Timestamp" that is mandatory for processing this request is not supplied.</Message>
<RequestId>3b237773-bc2c-4bea-95fc-319a1a5baa68</RequestId>
</KMS>JSON 形式
{
"HttpStatus": 400,
"Code": "IllegalTimestamp",
"Message": "The input parameter \"Timestamp\" that is mandatory for processing this request is not supplied.",
"RequestId": "e85db688-a2d3-44ca-9790-4259f59e90d8"
}一般的なエラーコード
期限切れのセキュリティトークンサービス（STS）トークンは、次のエラーコードをトリガーする可能性があります。
InvalidAccessKeyId.NotFound
Forbidden.NoPermission
Forbidden.AccessKey
エラーコード | 説明 | HTTP 状態コード |
InternalFailure | 内部エラー。 | 500 |
ServiceUnavailableTemporary | サービスは一時的に利用できません。 | 503 |
InvalidAccessKeyId.NotFound | 指定された AccessKey ID はレコードに存在しません。 | 404 |
Forbidden.KeyNotFound | 指定されたキーが見つかりません。 | 404 |
Forbidden.KeyVersionNotFound | 指定されたキーバージョンが見つかりません。 | 404 |
Forbidden.AliasNotFound | 指定されたエイリアスが見つかりません。 | 404 |
Forbidden.NoPermission | この操作は権限システムによって禁止されています。 | 403 |
Forbidden.AccessKey | この AccessKey は有効になっていません。 | 403 |
UnsupportedHTTPMethod | この HTTP メソッドはサポートされていません。 | 403 |
Forbidden.UbsmsInvalidUserid | Ubsms に対して無効な Userid です。 | 403 |
Forbidden.UbsmsInvalidBid | アカウントパートナーは KMS サービスを持っていません。 | 403 |
Forbidden.KmsServiceNotEnabled | 現在のユーザーに対して KMS サービスが有効になっていません。最初にアクセス許可を取得してください。 | 403 |
Forbidden.ProhibitedByRiskControl | 現在のユーザーはリスクコントロールによって禁止されています。 | 403 |
Forbidden.InDebtOverdue | 現在のユーザーは債務延滞です。 | 403 |
Forbidden.InDebt | 現在のユーザーは負債を抱えています。 | 403 |
ParseRequestParameterException | サーバーパラメーターの解析例外です。入力パラメーターを確認してください。 | 400 |
MissingParameter | パラメーター「< parameter name >」は必須ですが、提供されていません。 | 400 |
InvalidParameter | 指定されたパラメーター「< parameter name >」は無効です。 | 400 |
IncompleteSignature | リクエスト署名が Alibaba Cloud 標準に準拠していません。 | 400 |
IllegalTimestamp | このリクエストの処理に必要な入力パラメーター「Timestamp」が提供されていません。 | 400 |
Rejected.LimitExceeded | ユーザーが作成したリソースの制限を超えたため、リクエストは拒否されました。 | 400 |
AliasAlreadyExists | AliasName は既に存在します。 | 400 |
InvalidKeyMaterial | キーマテリアルが無効です。 | 400 |
InvalidImportToken | インポートトークンが無効です。 | 400 |
ExpiredImportToken | インポートトークンの期限が切れました。 | 400 |
Unsupported.Origin | このキーの由来はこの API では無効です。 | 400 |
Unsupported.Alias | エイリアスはこの API では無効です。 | 400 |
Unsupported.ProtectionLevel | この保護レベルはこのリージョンでは無効です。 | 400 |
Rejected.StateModifiedFailed | キーの状態の変更に失敗しました。 | 409 |
Rejected.Disabled | キーの状態が無効になっているため、リクエストは拒否されました。 | 409 |
Rejected.PendingDeletion | キーの状態が削除保留中のため、リクエストは拒否されました。 | 409 |
Rejected.PendingImport | キーの状態がインポート保留中のため、リクエストは拒否されました。 | 409 |