Obtaining the Rule List by Page

Function

This API is used to obtain the rule list by page.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{domain_id}/rules/query

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cloud_project_id	No	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
offset	Yes	Integer	Definition: Offset where the query starts. This parameter must be used together with limit. Constraints: N/A Value range: The offset value must be no less than 0. Default value: N/A
limit	Yes	Integer	Definition: Number of records of each query. Constraints: N/A Value range: 1 to 100. Default value: N/A
type	No	String	Definition: Rule type. Constraints: N/A Value range: N/A Default value: N/A
name	No	String	Definition: Rule name, which is used for fuzzy search. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	Array of Rule objects	Definition: Static rule list. Value range: N/A
total	Integer	Definition: Total number of queried static rules. Value range: N/A

**Table 5** Rule
Parameter	Type	Description
id	String	Definition: Rule ID. Value range: N/A
type	String	Definition: Rule type. Value range: N/A
name	String	Definition: Rule name. Value range: N/A
version	String	Definition: Rule version. Value range: N/A
operator	String	Definition: Latest operator. Value range: N/A
operate_time	Long	Definition: Last operation time. Value range: N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Example Requests

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/query?cloud_project_id=&type=&name=&limit=10&offset=1

Example Responses

Status code: 200

Request succeeded.

{
  "data" : [ {
    "id" : "425eba0deaf04596a74cf7967d7fc04d",
    "type" : "Test",
    "name" : "New Rule-20230919104204",
    "version" : "07ef68721822485dba6c326829567095",
    "operator" : "SectestB",
    "operate_time" : 1695091381000
  }, {
    "id" : "35a14c7a215745999cd579cfd862982e",
    "type" : "Gate",
    "name" : "0919-0919",
    "version" : "318e271a3fb24a888d5f484244ee994d",
    "operator" : "SectestB",
    "operate_time" : 1695091297000
  }, {
    "id" : "fddb790b7b024c6aa8d53e50577b1464",
    "type" : "Gate",
    "name" : "New Rule 0919",
    "version" : "185537e4a10e418ba5f8ad424fabbb7e",
    "operator" : "SectestB",
    "operate_time" : 1695091251000
  }, {
    "id" : "062f3ca8f9b14eb79af09069a227fc8c",
    "type" : "Gate",
    "name" : "Creating a Rule iam",
    "version" : "c12fb9341230457890993533e03ab374",
    "operator" : "testqxy",
    "operate_time" : 1695072045000
  }, {
    "id" : "b3def7ae86d844718de5eb248c1271d3",
    "type" : "Gate",
    "name" : "Creating rule iam0023",
    "version" : "58a0ee7673924a1dadcf6ec28d23864c",
    "operator" : "SectestB",
    "operate_time" : 1694682961000
  }, {
    "id" : "ce74e818321d4d40b5235c0309fd8cda",
    "type" : "Gate",
    "name" : "apitest-create-1694588962601-QsaY",
    "version" : "d65df316e067454db9467736412db418",
    "operator" : "xxx",
    "operate_time" : 1694588963000
  }, {
    "id" : "22973b3a02fe439ea8b642b3a6e23e02",
    "type" : "Gate",
    "name" : "Check",
    "version" : "14cb09a530c744418013cf254e7dd262",
    "operator" : "testjyw",
    "operate_time" : 1694500871000
  }, {
    "id" : "a440107f12ea40439abf7203c0b3c264",
    "type" : "Build",
    "name" : "New Rule-20230912144025",
    "version" : "1e99dbd87183453e9c719ded49cd3f9d",
    "operator" : "testjyw",
    "operate_time" : 1694500845000
  }, {
    "id" : "590700d339d44fb9beee87366332509b",
    "type" : "Gate",
    "name" : "New rule-20230912140536",
    "version" : "a35c74fc13ea4cdfa32ca541b3b92b2d",
    "operator" : "xxx",
    "operate_time" : 1694498754000
  }, {
    "id" : "defe9a17d6ae468cb7224b080fe418a3",
    "type" : "Gate",
    "name" : "New Rule-20230911100734-chq",
    "version" : "dbd00db8d87747fda87eb0b9a0a4d3ac",
    "operator" : "xxx",
    "operate_time" : 1694398087000
  } ],
  "total" : 50
}