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.	您的專屬KMS狀態為無效狀態。
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.	您指定的專屬kms執行個體未找到。
404	Forbidden.KeyNotFound	The specified Key is not found.	指定的密鑰不存在。
404	Forbidden.ResourceNotFound	Resource not found.	資源找不到

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

變更歷史

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