GetSecretValue - Key Management Service

取得憑據值。

介面說明

RAM 使用者或 RAM 角色呼叫此 OpenAPI 需要被授予的權限策略詳情，請參見存取控制。
如果未指定版本號或版本狀態，則 KMS 預設傳回被標記為 ACSCurrent 的版本憑據值。
如果憑據使用了使用者指定的金鑰來保護憑據值，則需要呼叫者同時具備相應主金鑰的 kms:Decrypt 權限。

本文將提供一個範例，取得一個名為 secret001 憑據的憑據值，傳回結果顯示憑據值 SecretData 為 testdata1。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
SecretName	string	是	憑據名稱或憑據資源名稱（ARN）。說明存取其他阿里雲帳號下的憑據時，必須輸入憑據 ARN。憑據 ARN 的格式為 `acs:kms:${region}:${account}:secret/${secret-name}`。	secret001
VersionStage	string	否	版本狀態。預設值：ACSCurrent。輸入此參數時傳回指定版本狀態的憑據值，未輸入此參數時傳回 ACSCurrent 版本狀態的憑據值。說明 RDS 憑據、PolarDB 憑據、Redis/Tair 憑據、RAM 憑據和 ECS 憑據僅能取得 ACSPrevious 和 ACSCurrent 對應版本的憑據值。	ACSCurrent
VersionId	string	否	版本號。說明 RDS 憑據、PolarDB 憑據、Redis/Tair 憑據、RAM 憑據和 ECS 憑據不支援指定 VersionId，設定此參數將被忽略。	v1
FetchExtendedConfig	boolean	否	是否取得憑據的擴充設定。取值： true：取得 false（預設值）：不取得說明通用憑據不支援擴充設定，設定此參數將被忽略。	true
DryRun	string	否	是否開啟 DryRun 模式。 true：開啟 false（預設值）：關閉 DryRun 模式用於測試 API 呼叫，驗證您是否具有相應資源的權限，以及請求參數是否設定正確。DryRun 模式開啟後，KMS 會始終傳回失敗並提示失敗原因。失敗原因包含如下： DryRunOperationError：未設定 DryRun 參數時，請求會成功。 ValidationError：請求中指定的參數有誤。 AccessDeniedError：您無權在 KMS 資源上執行此操作。	false

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object
SecretDataType	string	憑據值類型。取值： text binary	binary
CreateTime	string	建立憑據的時間。	2024-02-21T15:39:26Z
VersionId	string	憑據的版本號。	v1
NextRotationDate	string	下一次輪替的時間。說明當自動輪替開啟時，傳回此參數。	2024-07-06T18:22:03Z
SecretData	string	憑據值。KMS 將儲存的密文憑據值進行解密後傳回此參數。通用憑據傳回您指定的憑據值。 RDS 憑據、Redis/Tair 憑據傳回的憑據值滿足格式：`{"AccountName":"","AccountPassword":""}`。 RAM 憑據傳回的憑據值滿足格式：`{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`。 ECS 憑據傳回的憑據值滿足以下格式：密碼類型憑據：`{"UserName":"ecs-user","Password":"H5asdasdsads**"}`。公私鑰類型憑據（私鑰格式為 PEM）：`{"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}`。 PolarDB 憑據傳回的憑據值滿足格式：`{"AccountName":"","AccountPassword":""}`。	testdata1
RotationInterval	string	憑據自動輪替的週期。格式為 `integer[unit]`，其中 `integer` 表示時間長度，`unit` 表示時間單位。`unit` 取值：s（秒）。例如：7 天的輪替週期為 604800s。說明當自動輪替開啟時，傳回此參數。	604800s
ExtendedConfig	string	憑據的擴充設定。說明當 FetchExtendedConfig 取值為 true 時，僅 RDS 憑據、PolarDB 憑據、Redis/Tair 憑據、RAM 憑據或 ECS 憑據傳回此參數。	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	最近一次輪替的時間。說明當憑據發生過輪替時傳回此參數。	2023-07-05T08:22:03Z
RequestId	string	本次呼叫請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	6a3e9c36-1150-4881-84d3-eb8672fcafad
SecretName	string	憑據名稱。	secret001
AutomaticRotation	string	是否開啟了自動輪替。取值： Enabled：已開啟自動輪替。 Disabled：未開啟自動輪替。 Invalid：輪替狀態異常，KMS 無法為您自動輪替。說明僅 RDS 憑據、PolarDB 憑據、Redis/Tair 憑據、RAM 憑據或 ECS 憑據傳回此參數。	Enabled
SecretType	string	憑據類型。取值： Generic：通用憑據。 Rds：RDS 憑據。 Redis：Redis/Tair 憑據。 RAMCredentials：RAM 憑據。 ECS：ECS 憑據。 PolarDB：PolarDB 憑據。	Generic
VersionStages	array	憑據版本的狀態標記。
	string	憑據版本的狀態標記。	{ "VersionStage": [ "ACSCurrent" ] }

樣本

正常返回樣本

JSON格式

{
  "SecretDataType": "binary",
  "CreateTime": "2024-02-21T15:39:26Z",
  "VersionId": "v1",
  "NextRotationDate": "2024-07-06T18:22:03Z",
  "SecretData": "testdata1",
  "RotationInterval": "604800s",
  "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate": "2023-07-05T08:22:03Z",
  "RequestId": "6a3e9c36-1150-4881-84d3-eb8672fcafad",
  "SecretName": "secret001",
  "AutomaticRotation": "Enabled",
  "SecretType": "Generic",
  "VersionStages": [
    "{ \"VersionStage\": [ \t\"ACSCurrent\" \t] }"
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
403	Forbidden.DKMSInstanceStateInvalid	The DKMS instance state is invalid.
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.
404	Forbidden.ResourceNotFound	Resource not found.

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

變更歷史

更多資訊，參考變更詳情。