Querying Project-Level Open-Source Governance Policy Details

rule_set_id

Yes

String

Definition:

Policy ID, which is the unique identifier of a policy. Obtain the policy ID by calling the API for querying policies. data.id indicates the policy ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

id

String

Definition:

ID of an open-source governance policy.

Value range:

The value consists of 32 characters, including digits and letters.

name

String

Definition:

Name of an open-source governance policy.

Value range:

Enter a maximum of 128 characters.

level

String

Definition:

Open-source governance policy level.

Value range:

N/A

parent_id

String

Definition:

ID of an open-source governance parent policy.

Value range:

N/A

version

String

Definition:

Open-source governance policy version.

Value range:

N/A

is_valid

Boolean

Definition:

Whether the open-source governance policy is enabled.

Value range:

• true: enabled.

• false: disabled.

is_public

Boolean

Definition:

Whether the policy is a system-level policy.

Value range:

• true: The policy is a system-level policy.

• false: The policy is not a system-level policy.

creator

String

Definition:

Creator of an open-source governance policy.

Value range:

N/A

create_time

String

Definition:

Time when an open-source governance policy was created.

Value range:

N/A

updater

String

Definition:

User who updated the open-source governance policy.

Value range:

N/A

update_time

String

Definition:

Time when the open-source governance policy was updated.

Value range:

N/A

content

OpenSourceRuleContent object

Definition:

Details about an open-source governance policy rule.

Value range:

N/A

version_set

VersionSetProperty object

Definition:

Open-source dependency.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

security

SecurityProperty object

Definition:

Vulnerability.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

license

LicenseProperty object

Definition:

License.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

enable

Boolean

Definition:

Whether to enable the rule.

Constraints:

N/A

Value range:

• true: enabled.

• false: disabled.

Default value:

N/A

rules

Array of VersionSetRule objects

Definition:

Rule list.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

enable

Boolean

Definition:

Whether to enable.

Constraints:

N/A

Value range:

• true: enabled.

• false: disabled.

Default value:

N/A

ecosystem

String

Definition:

Dependency type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

package_name

String

Definition:

Package name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

package_version

String

Definition:

Package version.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

String

Definition:

Rule description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

predicate

String

Definition:

Comparison rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

enable

Boolean

Definition:

Whether to enable the rule.

Constraints:

N/A

Value range:

• true: enabled.

• false: disabled.

Default value:

N/A

rules

SecurityRule object

Definition:

Rule details.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

severity

severity object

Definition:

Vulnerability severity.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

cve

cve object

Definition:

Vulnerability ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

enable

Boolean

Definition:

Whether to enable the rule.

Constraints:

N/A

Value range:

• true: enabled.

• false: disabled.

Default value:

N/A

values

Array of strings

Definition:

Vulnerability severity.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

enable

Boolean

Definition:

Whether to enable the rule.

Constraints:

N/A

Value range:

• true: enabled.

• false: disabled.

Default value:

N/A

values

Array of strings

Definition:

Vulnerability ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

enable

Boolean

Definition:

Whether to enable.

Constraints:

N/A

Value range:

• true: enabled.

• false: disabled.

Default value:

N/A

rules

Array of rules objects

Definition:

Rule list.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

values

Array of strings

Definition:

License details.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

predicate

String

Definition:

Comparison rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_code

String

Definition:

Error code.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Definition:

Error message.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found