DescribeSecret - 密钥管理服务

此接口返回指定凭据的元数据信息，不返回凭据值。

本文将提供一个示例，查询一个名称为secret001凭据的元数据信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSecret	要执行的操作。取值：DescribeSecret。
SecretName	String	是	secret001	凭据名称或凭据资源名称（ARN）。说明访问其他阿里云账号下的凭据时，必须输入凭据ARN。凭据ARN的格式为`acs:kms:${region}:${account}:secret/${secret-name}`。
FetchTags	String	否	true	是否在返回参数中包含凭据的资源标签。取值： true：包含资源标签。 false（默认值）：不包含资源标签。

关于公共请求参数的详情，请参见公共参数。

返回数据

名称	类型	示例值	描述
UpdateTime	String	2024-02-21T15:39:26Z	凭据的更新时间。
CreateTime	String	2024-02-21T15:39:26Z	创建凭据的时间。
NextRotationDate	String	2024-07-06T18:22:03Z	下一次轮转的时间。说明当开启自动轮转时，返回该参数。
EncryptionKeyId	String	key-hzz63ca8cbe3hefht****	加密凭据值的KMS密钥的标识符。
RotationInterval	String	3153600s	凭据自动轮转的周期。格式为`integer[unit]`，其中`integer`表示时间长度，`unit`表示时间单位。 `unit`取值：s（秒）。例如：7天的轮转周期为604800s。说明当开启自动轮转时，返回该参数。
Arn	String	acs:kms:cn-hangzhou:154035569884****:secret/secret001	凭据的资源名称（ARN）。
ExtendedConfig	String	{\"AccountName\":\"kms\",\"Database\":\"kmsdata\",\"AccountPrivilege\":\"RoleReadOnly\",\"CloneAccountName\":\"kms_clone\",\"CustomData\":{},\"InstanceId\":\"pc-bp134f7hnijoey****\",\"RegionId\":\"cn-hangzhou\",\"SecretSubType\":\"DoubleUsers\"}"	凭据的拓展配置。说明仅RDS凭据、RAM凭据、PolarDB凭据或ECS凭据返回该参数。
LastRotationDate	String	2022-07-05T08:22:03Z	最近一次轮转的时间。说明当凭据发生过轮转时返回该参数。
RequestId	String	93348dfb-3627-4417-8d90-487a76a909c9	本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
Description	String	userinfo	凭据的描述信息。
SecretName	String	secret001	凭据名称。
AutomaticRotation	String	Enabled	是否开启自动轮转。取值： Enabled：开启自动轮转。 Disabled：不开启自动轮转。 Invalid：轮转状态异常，KMS无法为您自动轮转。说明仅RDS凭据、PolarDB凭据、RAM凭据或ECS凭据返回该参数。
SecretType	String	Rds	凭据类型。取值： Generic：通用凭据。 Rds：RDS凭据。 RAMCredentials：RAM凭据。 ECS：ECS凭据。 PolarDB：PolarDB凭据
PlannedDeleteTime	String	2025-03-21T15:45:12Z	计划删除时间。
DKMSInstanceId	String	kst-bjj62d8f5e0sgtx8h****	KMS实例的实例ID。
Tags	Array of Tag		凭据的资源标签。如果入参FetchTags取值为false或者未指定，则不返回该参数。
Tag
TagValue	String	val1	标签值。
TagKey	String	key1	标签键。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSecret
&SecretName=secret001
&FetchTags=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSecretResponse>
    <UpdateTime>2024-02-21T15:39:26Z</UpdateTime>
    <CreateTime>2024-02-21T15:39:26Z</CreateTime>
    <NextRotationDate>2024-07-06T18:22:03Z</NextRotationDate>
    <EncryptionKeyId>key-hzz63ca8cbe3hefht****</EncryptionKeyId>
    <RotationInterval>3153600s</RotationInterval>
    <Arn>acs:kms:cn-hangzhou:154035569884****:secret/secret001</Arn>
    <ExtendedConfig>{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\",  \"CustomData\":{} }</ExtendedConfig>
    <LastRotationDate>2022-07-05T08:22:03Z</LastRotationDate>
    <RequestId>93348dfb-3627-4417-8d90-487a76a909c9</RequestId>
    <Description>userinfo</Description>
    <SecretName>secret001</SecretName>
    <AutomaticRotation>Enabled</AutomaticRotation>
    <SecretType>Rds</SecretType>
    <PlannedDeleteTime>2025-03-21T15:45:12Z</PlannedDeleteTime>
    <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>
    <Tags>
        <TagValue>val1</TagValue>
        <TagKey>key1</TagKey>
    </Tags>
</DescribeSecretResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "UpdateTime" : "2024-02-21T15:39:26Z",
  "CreateTime" : "2024-02-21T15:39:26Z",
  "NextRotationDate" : "2024-07-06T18:22:03Z",
  "EncryptionKeyId" : "key-hzz63ca8cbe3hefht****",
  "RotationInterval" : "3153600s",
  "Arn" : "acs:kms:cn-hangzhou:154035569884****:secret/secret001",
  "ExtendedConfig" : "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate" : "2022-07-05T08:22:03Z",
  "RequestId" : "93348dfb-3627-4417-8d90-487a76a909c9",
  "Description" : "userinfo",
  "SecretName" : "secret001",
  "AutomaticRotation" : "Enabled",
  "SecretType" : "Rds",
  "PlannedDeleteTime" : "2025-03-21T15:45:12Z",
  "DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h****",
  "Tags" : [ {
    "TagValue" : "val1",
    "TagKey" : "key1"
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
400	IllegalTimestamp	The input parameter Timestamp that is mandatory for processing this request is not supplied.	输入参数“时间戳”标明该请求已经不在可处理时间范围内。
400	InvalidParameter	The specified parameter is not valid.	参数非法。
403	Forbidden.NoPermission	You are not authorized to perform the operation.	操作无权限。

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