文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 项目级策略管理/ 查询项目级开源治理策略详情
更新时间:2025-08-19 GMT+08:00
分享

查询项目级开源治理策略详情

功能介绍

查询项目级开源治理策略详情

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/open-source/rule-sets/{rule_set_id}/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

参数解释

开源治理策略名称。

取值范围

不超过128个字符。

level

String

参数解释

开源治理策略级别。

取值范围

不涉及。

parent_id

String

参数解释

开源治理父策略ID。

取值范围

不涉及。

version

String

参数解释

开源治理策略版本。

取值范围

不涉及。

is_valid

Boolean

参数解释

开源治理策略是否启用。

取值范围

  • true:启用。

  • false:未启用。

is_public

Boolean

参数解释

是否系统级策略。

取值范围

  • true:是系统级策略。

  • false:不是系统级策略。

creator

String

参数解释

开源治理策略创建人。

取值范围

不涉及。

create_time

String

参数解释

开源治理策略创建时间。

取值范围

不涉及。

updater

String

参数解释

开源治理策略更新人。

取值范围

不涉及。

update_time

String

参数解释

开源治理策略更新时间。

取值范围

不涉及。

content

OpenSourceRuleContent object

参数解释

开源治理策略规则详情。

取值范围

不涉及。

表3 OpenSourceRuleContent

参数

参数类型

描述

version_set

VersionSetProperty object

参数解释

开源依赖。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

security

SecurityProperty object

参数解释

漏洞。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

license

LicenseProperty object

参数解释

许可证。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 VersionSetProperty

参数

参数类型

描述

enable

Boolean

参数解释

是否启用。

约束限制

不涉及。

取值范围

  • true:启用。

  • false:未启用。

默认取值

不涉及。

rules

Array of VersionSetRule objects

参数解释

规则列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表5 VersionSetRule

参数

参数类型

描述

enable

Boolean

参数解释

是否开启。

约束限制

不涉及。

取值范围

  • true:开启。

  • false:未开启。

默认取值

不涉及。

ecosystem

String

参数解释

依赖类型。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

package_name

String

参数解释

包名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

package_version

String

参数解释

包版本。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

规则说明。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

predicate

String

参数解释

比较规则。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表6 SecurityProperty

参数

参数类型

描述

enable

Boolean

参数解释

是否启用。

约束限制

不涉及。

取值范围

  • true:启用。

  • false:未启用。

默认取值

不涉及。

rules

SecurityRule object

参数解释

规则详情。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表7 SecurityRule

参数

参数类型

描述

severity

severity object

参数解释

漏洞级别。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cve

cve object

参数解释

漏洞编号。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表8 severity

参数

参数类型

描述

enable

Boolean

参数解释

是否启用。

约束限制

不涉及。

取值范围

  • true:启用。

  • false:未启用。

默认取值

不涉及。

values

Array of strings

参数解释

漏洞等级。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表9 cve

参数

参数类型

描述

enable

Boolean

参数解释

是否启用。

约束限制

不涉及。

取值范围

  • true:启用。

  • false:未启用。

默认取值

不涉及。

values

Array of strings

参数解释

漏洞编号。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表10 LicenseProperty

参数

参数类型

描述

enable

Boolean

参数解释

是否开启。

约束限制

不涉及。

取值范围

  • true:开启。

  • false:未开启。

默认取值

不涉及。

rules

Array of rules objects

参数解释

规则列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表11 rules

参数

参数类型

描述

values

Array of strings

参数解释

license详情。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

predicate

String

参数解释

比较规则。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:400

表12 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

状态码:401

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:403

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:404

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档