UpdateKeyDescription -

將主要金鑰（CMK）的描述資訊（DescribeKey介面中的Description屬性）替換為使用者傳入的值。使用此API可以對密鑰的描述資訊進行添加、變更、刪除操作。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	UpdateKeyDescription	要執行的操作。取值：UpdateKeyDescription。
KeyId	String	是	1234abcd-12ab-34cd-56ef-12345678****	密鑰ID。主要金鑰的通用唯一識別碼。
Description	String	是	key description example	主要金鑰的描述性資訊。通常用於描述主要金鑰的用途，例如主要金鑰保護的資料類型、可使用主要金鑰的應用等。

返回資料

名稱	類型	樣本值	描述
RequestId	String	3455b9b4-95c1-419d-b310-db6a53b09a39	本次調用請求的ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。

樣本

請求樣本

http(s)://[Endpoint]/?Action=UpdateKeyDescription
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&Description=key description example
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。