接口请求域名： ssm.intl.tencentcloudapi.com 。
获取凭据的详细属性信息。
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSecret。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SecretName | 是 | String | 指定需要获取凭据详细信息的凭据名称。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 凭据名称。 |
| Description | String | 凭据描述信息。 |
| KmsKeyId | String | 用于加密的KMS CMK ID。 |
| CreateUin | Integer | 创建者UIN。 |
| Status | String | 凭据状态：Enabled、Disabled、PendingDelete, Creating, Failed。 |
| DeleteTime | Integer | 删除日期，uinx 时间戳，非计划删除状态的凭据为0。 |
| CreateTime | Integer | 创建日期。 |
| SecretType | Integer | 0 -- 用户自定义凭据类型；1 -- 数据库凭据类型；2 -- SSH密钥对凭据类型；3 -- 云API密钥（AKSK）凭据类型（使用此功能需要联系云助手单独开启白名单）；4 -- Redis类型凭据。 |
| ProductName | String | 云产品名称。 |
| ResourceID | String | 云产品实例ID。 |
| RotationStatus | Boolean | 是否开启轮转：True -- 开启轮转；False -- 关闭轮转。 |
| RotationFrequency | Integer | 轮转周期，默认以天为单位。 |
| ResourceName | String | 当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对凭据的名称。 |
| ProjectID | Integer | 当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对所属的项目ID。 |
| AssociatedInstanceIDs | Array of String | 当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对所关联的CVM实例ID。 |
| TargetUin | Integer | 当凭据类型为云API密钥对凭据时，此字段有效，用于表示此云API密钥对所属的用户UIN。 |
| AdditionalConfig | String | 凭据额外配置 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
获取凭据详情信息
https://ssm.intl.tencentcloudapi.com/?Action=DescribeSecret
&SecretName=test3-db-secret
&<公共请求参数>
{
"Response": {
"AdditionalConfig": "key1",
"AssociatedInstanceIDs": [
"cvm-test"
],
"CreateTime": 1730272571,
"CreateUin": 700001224419,
"DeleteTime": 0,
"Description": "测试数据库凭据创建",
"KmsKeyId": "6abd1fdb-86d4-11ef-b72d-52540089bc41",
"ProductName": "Mysql",
"ProjectID": 0,
"RequestId": "deb31013-2d0d-4b0c-a9dd-b62d8c3b2465",
"ResourceID": "cdb-n4j3y33j",
"ResourceName": "testresource",
"RotationFrequency": 30,
"RotationStatus": true,
"SecretName": "test3-db-secret",
"SecretType": 1,
"Status": "Enabled",
"TargetUin": 0
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied.RoleNotExist | 角色不存在。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |
| UnauthorizedOperation | 未授权操作。 |
文档反馈