DescribeSecret_密钥管理服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

此接口返回指定凭据的元数据信息,不返回凭据值。
本文将提供一个示例,查询一个名称为secret001凭据的元数据信息。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
SecretNamestring

凭据名称或凭据资源名称(ARN)。展开详情

示例值:secret001参考取值来源:
    UpdateSecret
    CreateSecret
    RotateSecret
    PutSecretValue
    RestoreSecret
    ListSecrets
FetchTagsstring

是否在返回参数中包含凭据的资源标签。取值: 展开详情

示例值:true枚举值:falsetrue

请求说明

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

返回参数

字段名称字段详情
UpdateTimestring

凭据的更新时间。

示例值:2024-02-21T15:39:26Z
CreateTimestring

创建凭据的时间。

示例值:2024-02-21T15:39:26Z
NextRotationDatestring

下一次轮转的时间。展开详情

示例值:2024-07-06T18:22:03Z
EncryptionKeyIdstring

加密凭据值的 KMS 密钥的标识符。

示例值:key-hzz63ca8cbe3hefht****
RotationIntervalstring

凭据自动轮转的周期。 展开详情

示例值:3153600s
Arnstring

凭据的资源名称(ARN)。

示例值:acs:kms:cn-hangzhou:154035569884****:secret/secret001
ExtendedConfigstring

凭据的拓展配置。 展开详情

示例值:{\"AccountName\":\"kms\",\"Database\":\"kmsdata\",\"AccountPrivilege\":\"RoleReadOnly\",\"CloneAccountName\":\"kms_clone\",\"CustomData\":{},\"InstanceId\":\"pc-bp134f7hnijoey****\",\"RegionId\":\"cn-hangzhou\",\"SecretSubType\":\"DoubleUsers\"}"
LastRotationDatestring

最近一次轮转的时间。展开详情

示例值:2022-07-05T08:22:03Z
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例值:93348dfb-3627-4417-8d90-487a76a909c9
Descriptionstring

凭据的描述信息。

示例值:userinfo
SecretNamestring

凭据名称。

示例值:secret001
AutomaticRotationstring

是否开启自动轮转。取值:展开详情

示例值:Enabled
SecretTypestring

凭据类型。取值:展开详情

示例值:Rds
PlannedDeleteTimestring

计划删除时间。

示例值:2025-03-21T15:45:12Z
DKMSInstanceIdstring

KMS 实例的实例 ID。

示例值:kst-bjj62d8f5e0sgtx8h****
Tagsobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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
变更错误码400
变更错误码403
删除错误码500
2022-09-22
变更错误码404

相关示例

通过调用 CreateSecret,ListSecrets,DescribeSecret,DeleteSecret,RestoreSecret 接口创建,查询,删除,恢复凭据示例
2022-06-17