全部產品
Search
文件中心

Key Management Service:GetManagedDataKey

更新時間:Jul 22, 2026

取得受管資料金鑰明文。

介面說明

RAM 使用者或 RAM 角色呼叫此 OpenAPI 需要被授予的權限原則詳情,請參見存取控制。

本介面可以透過共用閘道器呼叫。詳細介紹,請參見阿里雲 SDK。

  • 共用閘道器:透過公網、VPC 網域名稱存取 KMS。

調試

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

調試

授權資訊

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

請求文法

GET  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

DataKeyName

string

受管資料金鑰名稱,必填。

example-data-key

DataKeyVersionId

string

受管資料金鑰版本號碼,可選,設定了該參數會取得指定版本號碼的受管資料金鑰明文。

xH6OPUmz

UseLatest

boolean

在未提供版本號碼的情況下,是否使用最新的受管資料金鑰版本:

  • true:傳回最新的受管資料金鑰版本

  • false:傳回第一個受管資料金鑰版本

預設值:false

true

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

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

4bd560a1-729e-45f1-a3d9-b2a33d61046b

DataKeyName

string

受管資料金鑰名稱。

example-data-key

DataKeyVersionName

string

用於儲存傳回的受管資料金鑰版本金鑰材料的對應憑據名稱。

kms-datakeyversion!example-data-key!xH6OPUmz

DataKeyVersionId

string

傳回的受管資料金鑰版本號碼。

xH6OPUmz

Plaintext

string

資料金鑰的明文經過 Base64 編碼後的值。

CYueyVmZJ2MfA1VSZV2jCbFT8bO7StAvBnHacplr9aI=

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4bd560a1-729e-45f1-a3d9-b2a33d61046b",
  "DataKeyName": "example-data-key",
  "DataKeyVersionName": "kms-datakeyversion!example-data-key!xH6OPUmz",
  "DataKeyVersionId": "xH6OPUmz\n",
  "Plaintext": "CYueyVmZJ2MfA1VSZV2jCbFT8bO7StAvBnHacplr9aI="
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情