指定されたCMKの説明を更新します。

この操作により、CMKの説明 (DescribeKeyの説明値) が指定した値に置き換えられます。 この操作により、CMKの説明を追加、変更、または削除できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 UpdateKeyDescription

実行する操作です。 値をUpdateKeyDescriptionに設定します。
説明 String 必須 キーの説明の例

CMK の説明。 この説明には、保護するデータの種類やCMKを使用できるアプリケーションなど、CMKの目的が含まれています。
KeyId String 必須 1234abcd-12ab-34cd-56ef-12345678 ****

グローバルに一意な CMK の ID。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 3455b9b4-95c1-419d-b310-db6a53b09a39

リクエストの ID です。

例

リクエストの例

https://kms.cn-hangzhou.aliyuncs.com/?Action=UpdateKeyDescription
&Description=キーの説明の例
&KeyId=1234abcd-12ab-34cd-56ef-12345678 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<KMS>
   <RequestId>3455b9b4-95c1-419d-b310-db6a53b09a39</RequestId>
</KMS>

JSON 形式 

{
"RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。