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

查询项目级策略详情

功能介绍

查询项目级策略详情

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/rule-sets/{rule_set_id}/gray/detail

表1 路径参数

参数

是否必选

参数类型

描述

rule_set_id

是

String

参数解释：

策略ID，策略的唯一标识，通过获取策略列表接口获取，data.id即为策略ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释：

规则模板实例ID。

取值范围：

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

name

String

参数解释：

规则模板实例名称。

取值范围：

不涉及。

type

String

参数解释：

规则模板类型。

取值范围：

不涉及。

version

String

参数解释：

规则模板策略。

取值范围：

不涉及。

creator

String

参数解释：

策略创建人。

取值范围：

不涉及。

create_time

String

参数解释：

策略创建时间。

取值范围：

不涉及。

updater

String

参数解释：

策略最近更新人。

取值范围：

不涉及。

update_time

String

参数解释：

策略最近更新时间。

取值范围：

不涉及。

is_valid

Boolean

参数解释：

策略是否生效。

取值范围：

  • true：策略生效。

  • false：策略不生效。

rule_instances

Array of RuleInstance objects

参数解释：

规则实例集合。

取值范围：

不涉及。

level

String

参数解释：

规则实例生效级别。

取值范围：

不涉及。

is_public

Boolean

参数解释：

规则实例是否系统级。

取值范围：

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

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

is_legacy

Boolean

参数解释：

规则实例是1.0的数据。

取值范围：

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

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

表3 RuleInstance

参数

参数类型

描述

id

String

参数解释：

规则实例ID。

取值范围：

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

type

String

参数解释：

规则类型。

取值范围：

不涉及。

name

String

参数解释：

规则名称。

取值范围：

不涉及。

version

String

参数解释：

规则版本。

取值范围：

不涉及。

plugin_id

String

参数解释：

插件ID。

取值范围：

不涉及。

plugin_name

String

参数解释：

插件名称。

取值范围：

不涉及。

plugin_version

String

参数解释：

插件版本号。

取值范围：

不涉及。

is_valid

Boolean

参数解释：

规则是否生效。

取值范围：

  • true：规则生效。

  • false：规则不生效。

editable

Boolean

参数解释：

规则是否可编辑。

取值范围：

  • true：规则可编辑。

  • false：规则不可编辑。

content

Array of RuleInstanceContent objects

参数解释：

规则实例集合。

取值范围：

不涉及。

parent

RuleSet object

参数解释：

父级实例属性。

取值范围：

不涉及。

creator

String

参数解释：

规则创建人。

取值范围：

不涉及。

create_time

String

参数解释：

规则创建时间。

取值范围：

不涉及。

updater

String

参数解释：

规则最近更新人。

取值范围：

不涉及。

update_time

String

参数解释：

规则最近更新时间。

取值范围：

不涉及。

表4 RuleInstanceContent

参数

参数类型

描述

group_name

String

参数解释：

分组名称。

取值范围：

不涉及。

editable

Boolean

参数解释：

是否可编辑。

取值范围：

不涉及。

type

String

参数解释：

分组类型。

取值范围：

不涉及。

can_modify_when_inherit

Boolean

参数解释：

继承后的子策略是否可以修改阈值。

取值范围：

  • true：可以修改阈值。

  • false：不可以修改阈值。

properties

Array of RuleInstanceProperty objects

参数解释：

规则属性列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表5 RuleInstanceProperty

参数

参数类型

描述

key

String

参数解释：

规则属性键。

取值范围：

不涉及。

type

String

参数解释：

规则类型。

取值范围：

不涉及。

name

String

参数解释：

展示名称。

取值范围：

不涉及。

operator

String

参数解释：

比较运算符。

取值范围：

不涉及。

value

String

参数解释：

属性值。

取值范围：

不涉及。

value_type

String

参数解释：

数据类型。

取值范围：

  • float：数值型。

  • string：字符型。

is_valid

Boolean

参数解释：

是否生效。

取值范围：

  • true：生效。

  • false：不生效。

表6 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

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

GET https://{endpoint}/v2/d80a8a6530324b7bac972cbb8a9f28ec/rule-sets/f9228e23118c4fa5a9c86493ea0cffc2/gray/detail

响应示例

状态码：200

OK

{
  "id" : "f9228e23118c4fa5a9c86493ea0cffc2",
  "name" : "系统策略",
  "version" : "ace33a17a73442e398fedc123d047da2",
  "is_valid" : true,
  "creator" : "system",
  "create_time" : "2022-11-14T16:12:12",
  "updater" : "system",
  "update_time" : "2023-03-13T20:40:56",
  "rule_instances" : [ {
    "id" : "ee207826d1773f9122857474af314e48",
    "type" : "Gate",
    "name" : "API测试通过率门禁",
    "is_valid" : false,
    "version" : "90cd646fa8cd7f91d38e592dbb76a62e",
    "plugin_id" : "official_devcloud_apiTest",
    "plugin_name" : "official_devcloud_apiTest",
    "plugin_version" : "0.0.1",
    "content" : [ {
      "group_name" : "API测试通过率门禁",
      "can_modify_when_inherit" : true,
      "properties" : [ {
        "key" : "apitest",
        "type" : "judge",
        "name" : "api测试通过率",
        "value_type" : "float",
        "value" : "1.0",
        "operator" : ">="
      } ]
    } ]
  } ]
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。