GetSecretValue - 获取凭据值_密钥管理服务(KMS)-阿里云帮助中心

获取凭据值。

接口说明

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.	资源找不到

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。