文档首页/ 流水线 CodeArts Pipeline/ API参考（联盟区域）/ API/ 规则管理/ 分页获取规则列表
更新时间：2026-01-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

分页获取规则列表

功能介绍

分页获取规则列表

调用方法

请参见如何调用API。

URI

GET /v2/{domain_id}/rules/query

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释：

租户ID，用户的domainId。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

cloud_project_id

否

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

offset

是

Integer

参数解释：

偏移量，表示从此偏移量开始查询需配合limit一起使用。

约束限制：

不涉及。

取值范围：

offset大于等于0。

默认取值：

不涉及。

limit

是

Integer

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

1到100。

默认取值：

不涉及。

type

否

String

参数解释：

规则类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

规则名称，用于模糊搜索。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

Array of Rule objects

参数解释：

静态规则列表。

取值范围：

不涉及。

total

Integer

参数解释：

本次查询的静态规则总数。

取值范围：

不涉及。
表5 Rule

参数

参数类型

描述

id

String

参数解释：

规则ID。

取值范围：

不涉及。

type

String

参数解释：

规则类型。

取值范围：

不涉及。

name

String

参数解释：

规则名称。

取值范围：

不涉及。

version

String

参数解释：

规则版本。

取值范围：

不涉及。

operator

String

参数解释：

最近操作人员。

取值范围：

不涉及。

operate_time

Long

参数解释：

最近操作时间。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

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

响应示例

状态码：200

请求成功

{
  "data" : [ {
    "id" : "425eba0deaf04596a74cf7967d7fc04d",
    "type" : "Test",
    "name" : "新建规则-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" : "新建规则0919",
    "version" : "185537e4a10e418ba5f8ad424fabbb7e",
    "operator" : "SectestB",
    "operate_time" : 1695091251000
  }, {
    "id" : "062f3ca8f9b14eb79af09069a227fc8c",
    "type" : "Gate",
    "name" : "创建规则iam",
    "version" : "c12fb9341230457890993533e03ab374",
    "operator" : "testqxy",
    "operate_time" : 1695072045000
  }, {
    "id" : "b3def7ae86d844718de5eb248c1271d3",
    "type" : "Gate",
    "name" : "创建规则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" : "代码检查",
    "version" : "14cb09a530c744418013cf254e7dd262",
    "operator" : "testjyw",
    "operate_time" : 1694500871000
  }, {
    "id" : "a440107f12ea40439abf7203c0b3c264",
    "type" : "Build",
    "name" : "新建规则-20230912144025",
    "version" : "1e99dbd87183453e9c719ded49cd3f9d",
    "operator" : "testjyw",
    "operate_time" : 1694500845000
  }, {
    "id" : "590700d339d44fb9beee87366332509b",
    "type" : "Gate",
    "name" : "新建规则-20230912140536",
    "version" : "a35c74fc13ea4cdfa32ca541b3b92b2d",
    "operator" : "xxx",
    "operate_time" : 1694498754000
  }, {
    "id" : "defe9a17d6ae468cb7224b080fe418a3",
    "type" : "Gate",
    "name" : "新建规则-20230911100734-chq",
    "version" : "dbd00db8d87747fda87eb0b9a0a4d3ac",
    "operator" : "xxx",
    "operate_time" : 1694398087000
  } ],
  "total" : 50
}

状态码

状态码

描述

200

请求成功

400

请求失败

401

认证失败

403

无权限

404

资源不存在

错误码

请参见错误码。

父主题： 规则管理