文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 项目级策略管理/ 查询策略详情 - ShowProjectStrategyDetail
更新时间:2026-09-18 GMT+08:00

查询策略详情 - ShowProjectStrategyDetail

功能介绍

查询策略详情

调用方法

请参见如何调用API。

URI

GET /v2/{cloudProjectId}/rule-sets/{ruleSetId}/detail

表1 路径参数

参数

是否必选

参数类型

描述

cloudProjectId

是

String

项目ID

ruleSetId

是

String

策略ID

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释:

规则模板实例ID。

取值范围:

不涉及。

name

String

参数解释:

规则模板实例名称。

取值范围:

不涉及。

type

String

参数解释:

规则实例类型。

取值范围:

不涉及。

version

String

参数解释:

规则实例版本。

取值范围:

不涉及。

is_valid

Boolean

参数解释:

规则实例是否生效。

取值范围:

  • true:规则生效。

  • false:规则不生效。

level

String

参数解释:

规则实例生效级别。

取值范围:

不涉及。

is_public

Boolean

参数解释:

规则实例是否系统级。

取值范围:

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

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

is_legacy

Boolean

参数解释:

规则实例是1.0的数据。

取值范围:

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

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

  • null:规则实例不是1.0的数据。

creator

String

参数解释:

策略创建人。

取值范围:

不涉及。

create_time

String

参数解释:

策略创建时间。

取值范围:

不涉及。

updater

String

参数解释:

策略最近更新人。

取值范围:

不涉及。

update_time

String

参数解释:

策略最近更新时间。

取值范围:

不涉及。

rule_instances

Array of RuleInstance objects

参数解释:

规则实例集合。

取值范围:

不涉及。

表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:不生效。

请求示例

GET https://{endpoint}/v2/2d09f712e9504b61b034cc8f40e475a8/rule-sets/842cacd3424a470eb410300b537fa756/detail

响应示例

状态码:200

{
  "id" : "1dde04fab51e4a05880b176528957410",
  "name" : "创建策略-20260129102241",
  "level" : "project",
  "version" : "7968d4bc29974116876df416bdfd6760",
  "is_valid" : true,
  "is_public" : false,
  "creator" : "05d8ca972f114765a8984795a8aa4d41",
  "create_time" : "2026-01-29 10:22:54",
  "updater" : "05d8ca972f114765a8984795a8aa4d41",
  "update_time" : "2026-01-29 10:28:04",
  "rule_instances" : [ {
    "id" : "a78286b81469427bafa218d9640c4ec2",
    "type" : "Build",
    "name" : "1120",
    "is_valid" : true,
    "version" : "af4a439d47c5418dacb25fc6e6957aa1",
    "plugin_id" : "official_devcloud_cloudBuild",
    "plugin_name" : "official_devcloud_cloudBuild",
    "plugin_version" : "0.0.16",
    "content" : [ {
      "group_name" : "指令覆盖",
      "can_modify_when_inherit" : true,
      "editable" : true,
      "properties" : [ {
        "key" : "build.InstructionTotal",
        "type" : "judge",
        "name" : "指令总数",
        "value_type" : "float",
        "value" : "0",
        "operator" : "=",
        "is_valid" : true
      }, {
        "key" : "build.InstructionCovered",
        "type" : "judge",
        "name" : "指令覆盖数",
        "value_type" : "float",
        "value" : "0",
        "operator" : "=",
        "is_valid" : true
      }, {
        "key" : "build.InstructionCoverageRatio",
        "type" : "judge",
        "name" : "指令覆盖率",
        "value_type" : "float",
        "value" : "0",
        "operator" : "=",
        "is_valid" : true
      } ]
    } ],
    "creator" : "05d8ca972f114765a8984795a8aa4d41",
    "create_time" : "2025-11-21 16:06:23",
    "updater" : "05d8ca972f114765a8984795a8aa4d41",
    "update_time" : "2025-11-21 16:06:23"
  } ]
}

状态码

状态码

描述

200

查询策略详情响应体

错误码

请参见错误码。