Help Center/CodeArts Pipeline/API Reference/API/Rule Management/Obtaining the Rule List by Page
Updated on 2023-11-28 GMT+08:00
View PDF

Obtaining the Rule List by Page

Function

Obtaining the Rule List by Page

URI

GET /v2/{domain_id}/rules/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Indicates the tenant ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

cloud_project_id

No

String

Project ID.

offset

Yes

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

Yes

Integer

Number of records displayed on each page

type

No

String

Type

name

No

String

Rule name, which is used for fuzzy search.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of Rule objects

Static Rule List

total

Integer

Total number.

Table 5 Rule

Parameter

Type

Description

id

String

Rule ID

type

String

Rule type

name

String

Rule Name

version

String

Rule version.

operator

String

Latest Operator

operate_time

Long

Last Operation Time

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

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

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" : "devcloud_xxx",
    "operate_time" : 1694588963000
  }, {
    "id" : "22973b3a02fe439ea8b642b3a6e23e02",
    "type" : "Gate",
    "name" : "CodeCheck",
    "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" : "devcloud_xxx",
    "operate_time" : 1694498754000
  }, {
    "id" : "defe9a17d6ae468cb7224b080fe418a3",
    "type" : "Gate",
    "name" : "New Rule-20230911100734-chq",
    "version" : "dbd00db8d87747fda87eb0b9a0a4d3ac",
    "operator" : "devcloud_xxx",
    "operate_time" : 1694398087000
  } ],
  "total" : 379
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Failed request

401

Authentication failed.

403

No permission.

404

The resource does not exist.

Error Codes

See Error Codes.

Parent topic:Rule Management