API レスポンスは HTTP レスポンス形式を使用します。ステータスコードが 2XX の場合は呼び出しの成功を示し、ステータスコードが 4XX または 5XX の場合は呼び出しの失敗を示します。 このトピックのサンプル応答は、読みやすい方法でフォーマットされています。 実際の応答は改行またはインデントでフォーマットされていません。
正常に処理された場合のレスポンス例
XML形式
<?xml version="1.0" encoding="UTF-8"?>
<!--Result Root Node-->
<Interface Name+Response>
<!--Return Request Tag-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--Return Result Data-->
</Interface Name+Response>JSON 形式
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
}エラーレスポンスの例
API操作の呼び出し時にエラーが発生した場合、結果データは返されません。 返されたエラーコードと一般的なエラーに基づいてエラーをトラブルシューティングできます。
API操作の呼び出し時にエラーが発生した場合、リクエストのHTTPステータスコード、エラーコード、エラーメッセージ、およびIDがレスポンスで返されます。 エラーコードとエラーメッセージに基づいてエラーをトラブルシューティングできない場合は、Alibaba CloudテクニカルサポートにリクエストのIDを提供して、リクエストログを見つけることができます。 次のサンプル応答は、必要なタイムスタンプが指定されていない場合に発生するエラーを示しています。
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"
}一般的なエラーコード
エラーコード | 説明 | HTTPステータスコード |
InternalFailure | 内部エラーが発生しました。 | 500 |
ServiceUnavailableTemporary | サービスは一時的に利用できません。 | 503 |
InvalidAccessKeyId.NotFound | レコードに指定された Access Key Id がありません。 | 404 |
Forbidden.KeyNotFound | 指定されたキーが見つかりません。 | 404 |
Forbidden.KeyVersionNotFound | 指定されたキーバージョンが見つかりません。 | 404 |
Forbidden.AliasNotFound | 指定されたエイリアスが見つかりません。 | 404 |
Forbidden.NoPermission | この操作は権限システムによって禁止されています。 説明 このエラーは、RAM (Resource Access Management) ユーザーにアクセス権限がない場合、またはSTS (Security Token Service) トークンの有効期限が切れた場合に報告されます。 | 403 |
Forbidden.AccessKey | 使用できない AccessKey です。 | 403 |
UnsupportedHTTPMethod | サポートされていないメソッドです。 | 403 |
Forbidden.UbsmsInvalidUserid | Ubsms のユーザー ID が正しくありません。 | 403 |
Forbidden.UbsmsInvalidBid | アカウントパートナーに KMS サービスがありません。 | 403 |
Forbidden.KmsServiceNotEnabled | 現在のユーザーに対して KMS サービスが有効化されていません。 最初にアクセス権限を取得してください。 | 403 |
Forbidden.ProhibitedByRiskControl | 現在のユーザーはリスク管理によって禁止されています。 | 403 |
Forbidden.InDebtOverdue | 現在のユーザーで滞納が発生しています。 | 403 |
Forbidden.InDebt | 現在のユーザーで滞納が発生しています。 | 403 |
ParseRequestParameterException | サーバーがパラメーターの例外を検出しました。 入力パラメーターを確認してください。 | 400 |
MissingParameter | 必要なパラメーター "<パラメーター名>" が指定されていません。 | 400 |
InvalidParameter | 指定されたパラメーター "<パラメーター名>" は無効です。 | 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 |