跳到主要内容

查询规范列表

查询当前组织下的规范列表,支持分页返回。

请求地址:/openapi/v1/ruleSet/list

请求方法:POST

请求参数

参数类型是否必填说明示例
currentInteger当前页码,从 1 开始。默认值:11
pageSizeInteger每页返回条数。默认值:1010

请求示例

{
"current": 1,
"pageSize": 10
}

返回参数

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID,可用于问题排查和链路追踪。Mb7a1WVW-ciijhIPnifkv4PTddju5AYA
dataArray规范列表。请参见下方 data 字段说明[{...}]
currentInteger当前页码。1
pageSizeInteger每页返回条数。10
totalInteger符合查询条件的总记录数。39
errorCodeString调用失败时返回的错误码。
messageString调用失败时返回的异常信息。

data 字段说明

参数类型说明示例
idString规范 ID。rs-default-dev
nameString规范名称。默认开发环境规范
bindSumInteger已关联的资源数量。19
isDefaultBoolean是否为平台默认规范。true
createdTimeString规范创建时间。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
}