查询规范列表
查询当前组织下的规范列表,支持分页返回。
请求地址:/openapi/v1/ruleSet/list
请求方法:POST
请求参数
| 参数 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| current | Integer | 否 | 当前页码,从 1 开始。默认值:1。 | 1 |
| pageSize | Integer | 否 | 每页返回条数。默认值:10。 | 10 |
请求示例
{
"current": 1,
"pageSize": 10
}
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID,可用于问题排查和链路追踪。 | Mb7a1WVW-ciijhIPnifkv4PTddju5AYA |
| data | Array | 规范列表。请参见下方 data 字段说明。 | [{...}] |
| current | Integer | 当前页码。 | 1 |
| pageSize | Integer | 每页返回条数。 | 10 |
| total | Integer | 符合查询条件的总记录数。 | 39 |
| errorCode | String | 调用失败时返回的错误码。 | 无 |
| message | String | 调用失败时返回的异常信息。 | 无 |
data 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| id | String | 规范 ID。 | rs-default-dev |
| name | String | 规范名称。 | 默认开发环境规范 |
| bindSum | Integer | 已关联的资源数量。 | 19 |
| isDefault | Boolean | 是否为平台默认规范。 | true |
| createdTime | String | 规范创建时间。 | 2022-12-30 07:40:37 |
调用成功示例
{
"success": true,
"requestId": "Mb7a1WVW-ciijhIPnifkv4PTddju5AYA",
"data": [
{
"id": "rs-default-dev",
"name": "默认开发环境规范",
"bindSum": 19,
"isDefault": true,
"createdTime": "2022-12-30 07:40:37"
},
{
"id": "rs-default-prod",
"name": "默认生产环境规范",
"bindSum": 9,
"isDefault": true,
"createdTime": "2022-12-30 07:40:37"
}
],
"current": 1,
"pageSize": 10,
"total": 39
}