DescribeSecret - 查询凭据的元数据信息_密钥管理服务(KMS)-阿里云帮助中心

查询凭据的元数据信息。

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
此接口返回指定凭据的元数据信息，不返回凭据值。

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

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

返回参数

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

示例

正常返回示例

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": "{\\\"AccountName\\\":\\\"kms\\\",\\\"Database\\\":\\\"kmsdata\\\",\\\"AccountPrivilege\\\":\\\"RoleReadOnly\\\",\\\"CloneAccountName\\\":\\\"kms_clone\\\",\\\"CustomData\\\":{},\\\"InstanceId\\\":\\\"pc-bp134f7hnijoey****\\\",\\\"RegionId\\\":\\\"cn-hangzhou\\\",\\\"SecretSubType\\\":\\\"DoubleUsers\\\"}\"",
  "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": {
    "Tag": [
      {
        "TagValue": "val1",
        "TagKey": "key1"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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.	操作无权限。
404	Forbidden.ResourceNotFound	Resource not found	-
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	-

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

变更历史

变更时间	变更内容概要	操作
2023-03-08	OpenAPI 错误码发生变更	查看变更详情