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

获取项目级策略列表

功能介绍

获取项目级策略列表

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/rule-sets/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

limit

是

Integer

参数解释：

每次查询的条目数量。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

include_tenant_rule_set

是

Boolean

参数解释：

是否包含租户级规则。

约束限制：

不涉及。

取值范围：

  • true：包含租户级规则。

  • false：不包含租户级规则。

默认取值：

不涉及。

name

否

String

参数解释：

策略名称，用于模糊查询。

约束限制：

策略名称仅支持中文、大小写英文字母、数字、‘-’、‘_’。

取值范围：

不超过128个字符。

默认取值：

不涉及。

is_valid

否

Boolean

参数解释：

策略是否有效。

约束限制：

不涉及。

取值范围：

  • true：策略有效。

  • false：策略无效。

默认取值：

不涉及。

type

否

String

参数解释：

策略类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

Array of RuleSet objects

参数解释：

规则实例列表。

取值范围：

不涉及。

total

Long

参数解释：

规则总数。

取值范围：

不涉及。

表5 RuleSet

参数

参数类型

描述

id

String

参数解释：

规则模板实例ID。

取值范围：

不涉及。

name

String

参数解释：

规则模板实例名称。

取值范围：

不涉及。

type

String

参数解释：

规则实例类型。

取值范围：

不涉及。

version

String

参数解释：

规则实例版本。

取值范围：

不涉及。

operator

String

参数解释：

规则实例最近操作人。

取值范围：

不涉及。

operate_time

Long

参数解释：

规则实例最近操作时间。

取值范围：

不涉及。

is_valid

Boolean

参数解释：

规则实例是否生效。

取值范围：

  • true：规则生效。

  • false：规则不生效。

level

String

参数解释：

规则实例生效级别。

取值范围：

不涉及。

is_public

Boolean

参数解释：

规则实例是否系统级。

取值范围：

  • true：规则实例是系统级。

  • false：规则实例不是系统级。

is_legacy

Boolean

参数解释：

规则实例是1.0的数据。

取值范围：

  • true：规则实例是1.0的数据。

  • false：规则实例不是1.0的数据。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v2/d80a8a6530324b7bac972cbb8a9f28ec/rule-sets/query?name=&limit=10&offset=0&include_tenant_rule_set=false

响应示例

状态码：200

OK

{
  "data" : [ {
    "id" : "98183e0e70634f4d99da7dc549496652",
    "name" : "创建策略-20230915203425",
    "level" : "project",
    "is_valid" : true,
    "version" : "82ed35e3ecd041ebace8d62347042368",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1694781278000
  }, {
    "id" : "becbd00aa13147c6a226283a4bad57e0",
    "name" : "创建策略-20230817183223",
    "level" : "project",
    "is_valid" : true,
    "version" : "e3cc0a3df511486ea36bdcb46df724f8",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1693900336000
  }, {
    "id" : "52b24f9add844832a2af11f2e760c730",
    "name" : "codecheck-copy",
    "level" : "project",
    "is_valid" : true,
    "version" : "a2e50e1972f348e0838679eabe0b4467",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1693900325000
  }, {
    "id" : "d899845c2eff4fa18860fa4b31c5ee31",
    "name" : "codecheck",
    "level" : "project",
    "is_valid" : true,
    "version" : "20f79c6ff8844f5391882d7b3497761b",
    "operator" : "xxx",
    "is_public" : false,
    "operate_time" : 1693300726000
  } ],
  "total" : 4
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。