1. 接口描述
接口请求域名： ssm.api3.fincloud.tencent.cn。
该接口用于获取所有凭据的详细列表，可以指定过滤字段、排序方式等。
默认接口请求频率限制：30次/秒。
接口更新时间：2019-12-26 14:24:40。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ListSecrets |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-09-23 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Offset | 否 | 否 | Uint64 | 查询列表的起始位置，以0开始，不设置默认为0。 示例值： 0 |
| Limit | 否 | 否 | Uint64 | 单次查询返回的最大数量，0或不设置则使用默认值 20。 示例值： 2 |
| OrderType | 否 | 否 | Uint64 | 根据创建时间的排序方式，0或者不设置则使用降序排序， 1 表示升序排序。 示例值： 1 |
| State | 否 | 否 | Uint64 | 根据凭据状态进行过滤，默认为0表示查询全部，1 表示查询Enabed 凭据列表，2表示查询Disabled 凭据列表， 3 表示查询PendingDelete 凭据列表。 示例值： 1 |
| SearchSecretName | 否 | 否 | String | 根据凭据名称进行过滤，为空表示不过滤。 示例值： testName |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 根据State和SearchSecretName 筛选的凭据总数。 示例值： 8 |
| SecretMetadatas | Array of SecretMetadata | 返回凭据信息列表。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |
5. 示例
示例1 获取凭据详细信息列表
输入示例
https://ssm.api3.fincloud.tencent.cn/?Action=ListSecrets
&Limit=2
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "3586bdc7-c8a5-4ccd-883f-9f256a96533a",
"TotalCount": 8,
"SecretMetadatas": [
{
"SecretName": "test",
"Description": "test version 1.0",
"KmsKeyId": "13437ab9-e002-11e9-9936-5254006d0810",
"KmsKeyType": "DEFAULT",
"CreateUin": 3350000000,
"Status": "Enabled",
"DeleteTime": 0,
"CreateTime": 1574160561
},
{
"SecretName": "test2",
"Description": "test desc 2",
"KmsKeyId": "13437ab9-e002-11e9-9936-5254006d0810",
"KmsKeyType": "DEFAULT",
"CreateUin": 3350000000,
"Status": "Enabled",
"DeleteTime": 0,
"CreateTime": 1574067178
}
]
}
}