List Rule Sets

Use this API to query SQL rule sets in the current organization with pagination. The response returns rule set IDs and metadata for create, delete, or binding calls.

Request URL: /openapi/v1/ruleSet/list

Request Method: POST

Request Parameters

Parameter	Type	Required	Description	Example
current	Integer	No	Page number. Starts from 1. Default value: 1.	1
pageSize	Integer	No	Number of records per page. Default value: 10.	10

Request Example

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

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request is successful.	true
requestId	String	Request ID for troubleshooting and tracing.	Mb7a1WVW-ciijhIPnifkv4PTddju5AYA
data	Array	Rule set list. See data Fields.	[{...}]
current	Integer	Current page number.	1
pageSize	Integer	Number of records per page.	10
total	Integer	Total number of records that match the query conditions.	39
errorCode	String	Error code returned when the call fails.	None
message	String	Error message returned when the call fails.	None

data Fields

Parameter	Type	Description	Example
id	String	Rule set ID.	rs-default-dev
name	String	Rule set name.	Default Development Rule Set
bindSum	Integer	Number of associated resources.	19
isDefault	Boolean	Whether this is a default rule set.	true
createdTime	String	Time 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
}

Result

A successful response returns rule sets for the current organization. Use the returned id when you copy a rule set, delete a rule set, or bind resources to a rule set.