更新时间:2026-01-09 GMT+08:00

获取策略详情

功能介绍

获取策略详情

调用方法

请参见如何调用API。

URI

GET /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/detail

表1 路径参数

参数

是否必选

参数类型

描述

rule_set_id

是

String

参数解释:

策略ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

domain_id

是

String

参数解释:

租户ID,用户的domainId。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

cloud_project_id

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应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的数据。

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

参数解释:

规则最近更新时间。

取值范围:

不涉及。

表6 RuleInstanceContent

参数

参数类型

描述

group_name

String

参数解释:

分组名称。

取值范围:

不涉及。

editable

Boolean

参数解释:

是否可编辑。

取值范围:

不涉及。

type

String

参数解释:

分组类型。

取值范围:

不涉及。

can_modify_when_inherit

Boolean

参数解释:

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

取值范围:

  • true:可以修改阈值。

  • false:不可以修改阈值。

properties

Array of RuleInstanceProperty objects

参数解释:

规则属性列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表7 RuleInstanceProperty

参数

参数类型

描述

key

String

参数解释:

规则属性键。

取值范围:

不涉及。

type

String

参数解释:

规则类型。

取值范围:

不涉及。

name

String

参数解释:

展示名称。

取值范围:

不涉及。

operator

String

参数解释:

比较运算符。

取值范围:

不涉及。

value

String

参数解释:

属性值。

取值范围:

不涉及。

value_type

String

参数解释:

数据类型。

取值范围:

  • float:数值型。

  • string:字符型。

is_valid

Boolean

参数解释:

是否生效。

取值范围:

  • true:生效。

  • false:不生效。

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

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/detail?cloud_project_id=

响应示例

状态码:200

OK

{
  "id" : "6e7cbaab83d74909b23b0ead6f5d7895",
  "name" : "创建策略-20250617094501",
  "level" : "tenant",
  "version" : "720b4b4d98254c3c84e35d4ebe713d5b",
  "is_valid" : true,
  "is_public" : false,
  "creator" : "RkMqtmjMGUHeDp3QRubGpGcHxVeotKkQ",
  "create_time" : "2025-06-17 09:45:04",
  "updater" : "RkMqtmjMGUHeDp3QRubGpGcHxVeotKkQ",
  "update_time" : "2025-06-17 09:45:04",
  "rule_instances" : [ {
    "id" : "6b19515dac7e4e57aedf6a14ad521ed8",
    "type" : "Gate",
    "name" : "新建规则-20250617094444",
    "is_valid" : true,
    "version" : "3fa6f315958b41f7a3312cbd2d8ad0f1",
    "plugin_id" : "official_devcloud_codeCheck",
    "plugin_name" : "official_devcloud_codeCheck",
    "plugin_version" : "0.0.1",
    "content" : [ {
      "group_name" : "检查缺陷统计",
      "can_modify_when_inherit" : true,
      "editable" : true,
      "properties" : [ {
        "key" : "codecheck.deadly",
        "type" : "judge",
        "name" : "致命",
        "value_type" : "float",
        "value" : "0",
        "operator" : "=",
        "is_valid" : true
      } ]
    } ],
    "creator" : "RkMqtmjMGUHeDp3QRubGpGcHxVeotKkQ",
    "create_time" : "2025-06-17 09:44:55",
    "updater" : "RkMqtmjMGUHeDp3QRubGpGcHxVeotKkQ",
    "update_time" : "2025-06-17 09:44:55"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。