Skip to main content

List Rule Sets

Queries rule sets in the current organization with pagination.

Request URL: /openapi/v1/ruleSet/list

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
currentIntegerNoPage number. Starts from 1. Default value: 1.1
pageSizeIntegerNoNumber of records per page. Default value: 10.10

Request Example

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

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID for troubleshooting and tracing.Mb7a1WVW-ciijhIPnifkv4PTddju5AYA
dataArrayRule set list. See data Fields.[{...}]
currentIntegerCurrent page number.1
pageSizeIntegerNumber of records per page.10
totalIntegerTotal number of records that match the query conditions.39
errorCodeStringError code returned when the call fails.None
messageStringError message returned when the call fails.None

data Fields

ParameterTypeDescriptionExample
idStringRule set ID.rs-default-dev
nameStringRule set name.Default Development Rule Set
bindSumIntegerNumber of associated resources.19
isDefaultBooleanWhether this is a default rule set.true
createdTimeStringTime when the rule set was created.2022-12-30 07:40:37

Successful Invocation Example

{
"success": true,
"requestId": "Mb7a1WVW-ciijhIPnifkv4PTddju5AYA",
"data": [
{
"id": "rs-default-dev",
"name": "Default Development Rule Set",
"bindSum": 19,
"isDefault": true,
"createdTime": "2022-12-30 07:40:37"
},
{
"id": "rs-default-prod",
"name": "Default Production Rule Set",
"bindSum": 9,
"isDefault": true,
"createdTime": "2022-12-30 07:40:37"
}
],
"current": 1,
"pageSize": 10,
"total": 39
}