ListSecrets
更新时间：2023-03-07
ListSecrets
- 接口说明
凭据列举
- 请求URI
POST /ssm?action=ListSecrets请求体参数
- 请求体字段数据结构说明
| 名称 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| pageNo | Integer | 否 | 当前页数。 · 取值范围：大于0。 · 默认值：1。 |
1 |
| pageSize | Integer | 否 | 每页返回值的个数。 · 取值范围：1~100。 · 默认值：10。 |
10 |
| filters | []Filter | 否 | 搜索过滤条件 | [{"keywordType":"SecretName", "keyword":["name1","name2"]}, {"keywordType":"SecretType", "keyword":["Generic","BCC"]}, {"keywordType":"SecretId", "keyword":["SecretId1","SecretId2"]}] |
- Filter字段数据结构说明
| 名称 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| keywordType | String | 是 | 支持 SecretType 、SecretId、SecretName、SecretStatus | SecretType |
| keyword | String | 是 | · SecretType支持：Generic（通用凭据）、RDS（RDS凭据）、BCC（BCC凭据） · SecretStatus支持：Enabled（启用）、 Disabled（禁用） 、PendingDeletion（待删除） |
响应体参数
- 响应体字段数据结构说明
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| pageNumber | Integer | 页号 | |
| pageSize | Integer | 页面大小 | |
| secretsList | []Secret | 凭据列表 | |
| totalCount | Integer | 凭据总数 |
- Secret字段数据结构说明
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| SecretId | String | 凭据id | |
| SecretName | String | 凭据名称 | |
| SecretVersion | String | 凭据版本 | |
| SecretType | String | 凭据类型， Generic、BCC、RDS | Generic |
| SecretStatus | String | 凭据状态，Enabled、Disabled、PendingDeletion | Enabled |
| ScheduleDeleteTime | String | 凭据计划删除时间，UTC时间 | 2023-01-04T17:31:14+08:00 |
| UpdateTime | String | 最近一次轮转时间，未轮转则与创建时间一致，UTC时间 | 2023-01-04T17:31:14+08:00 |
| NextRotateTime | String | 下次轮转时间，未轮转则与创建时间一致，UTC时间 | 2023-01-04T17:31:14+08:00 |
| RotateEnabled | Boolean | 轮转开关 | true |
| RotateInterval | Integer | 轮转周期,7-365 | 7 |
请求示例
POST /ssm?action=ListSecrets
<公共请求头>
{
"pageNo":1,
"pageSize":10,
"filters":[{"keyWordType":"SecretStatus","keyword":["Enabled","Disabled"]}]
}响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"pageNumber":1,
"pageSize":10,
"totalCount":40,
"secretsList":[
{
"SecretId":"cf8a75a9-625d-0dfa-8a87-233f7c64c1cf",
"SecretName":"/kms/general/a_123",
"SecretVersion":"v1",
"SecretType":"Generic",
"SecretStatus":"Enabled",
"ScheduleDeleteTime": "1970-01-01T08:00:00+08:00",
"UpdateTime": "2023-01-04T17:31:14+08:00",
"NextRotateTime": "2023-01-04T17:31:14+08:00",
"RotateEnabled": false,
"RotateInterval": 0
},
...
],
}