DescribeSecret
最近更新时间: 2025-10-20 17:05:52
1. 接口描述
接口请求域名： ssm.api3.fincloud.tencent.cn。
获取凭据的详细属性信息。
默认接口请求频率限制：40次/秒。
接口更新时间：2019-12-26 14:21:41。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeSecret |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-09-23 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SecretName | 是 | 否 | String | 指定需要获取凭据详细信息的凭据名称。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 凭据名称。 |
| Description | String | 凭据描述信息。 |
| KmsKeyId | String | 用于加密的KMS CMK ID。 |
| CreateUin | Uint64 | 创建者UIN。 |
| Status | String | 凭据状态：Enabled、Disabled、PendingDelete |
| DeleteTime | Uint64 | 删除日期，uinx 时间戳，非计划删除状态的凭据为0。 |
| CreateTime | Uint64 | 创建日期。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |