全部產品
Search
文件中心

Key Management Service:UpdateKeyDescription - 更新主要金鑰描述資訊

更新時間:Dec 21, 2025

更新主要金鑰的描述資訊。

介面說明

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情,請參見存取控制

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

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

KeyId

string

金鑰識別碼。主要金鑰的通用唯一識別碼。

1234abcd-12ab-34cd-56ef-12345678****

Description

string

主要金鑰的描述性資訊。通常用於描述主要金鑰的用途,例如主要金鑰保護的資料類型、可使用主要金鑰的應用等。

key description example

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

3455b9b4-95c1-419d-b310-db6a53b09a39

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

更多資訊,參考變更詳情