Querying Project-Level 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:

Rule template instance ID.

Value range:

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

name

String

Definition:

Rule template instance name.

Value range:

N/A

type

String

Definition:

Rule template type.

Value range:

N/A

version

String

Definition:

Rule template policy.

Value range:

N/A

creator

String

Definition:

Policy creator.

Value range:

N/A

create_time

String

Definition:

Policy creation time.

Value range:

N/A

updater

String

Definition:

User who last updated the policy.

Value range:

N/A

update_time

String

Definition:

Time when the policy was last updated.

Value range:

N/A

is_valid

Boolean

Definition:

Whether the policy takes effect.

Value range:

• true: The policy takes effect.

• false: The policy does not take effect.

rule_instances

Array of RuleInstance objects

Definition:

Rule instance set.

Value range:

N/A

level

String

Definition:

Effective level of a rule instance.

Value range:

N/A

is_public

Boolean

Definition:

Whether the rule instance is system-level.

Value range:

• true: The rule instance is system-level.

• false: The rule instance is not system-level.

is_legacy

Boolean

Definition:

Whether the rule instance data is from version 1.0.

Range:

• true: The rule instance data is from version 1.0.

• false: The rule instance data is not from version 1.0.

id

String

Definition:

Rule instance ID.

Value range:

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

type

String

Definition:

Rule type.

Value range:

N/A

name

String

Definition:

Rule name.

Value range:

N/A

version

String

Definition:

Rule version.

Value range:

N/A

plugin_id

String

Definition:

Extension ID.

Value range:

N/A

plugin_name

String

Definition:

Extension name.

Value range:

N/A

plugin_version

String

Definition:

Extension version number.

Value range:

N/A

is_valid

Boolean

Definition:

Whether the rule takes effect.

Value range:

• true: The rule takes effect.

• false: The rule does not take effect.

editable

Boolean

Definition:

Whether the rule can be edited.

Value range:

• true: The rule can be edited.

• false: The rule cannot be edited.

content

Array of RuleInstanceContent objects

Definition:

Rule instance set.

Value range:

N/A

parent

RuleSet object

Definition:

Parent instance attribute.

Value range:

N/A.

creator

String

Definition:

Rule creator.

Value range:

N/A

create_time

String

Definition:

Time when a rule was created.

Value range:

N/A

updater

String

Definition:

User who last updated the rule.

Value range:

N/A

update_time

String

Definition:

Time when the rule was last updated.

Value range:

N/A

group_name

String

Definition:

Group name.

Value range:

N/A

editable

Boolean

Definition:

Editable or not.

Value range:

N/A

type

String

Definition:

Group type.

Value range:

N/A

can_modify_when_inherit

Boolean

Definition:

Whether the threshold of the inherited sub-policy can be modified.

Value range:

• true: The threshold can be modified.

• false: The threshold cannot be modified.

properties

Array of RuleInstanceProperty objects

Definition:

Rule attributes.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

key

String

Definition:

Rule attribute key.

Value range:

N/A

type

String

Definition:

Rule type.

Value range:

N/A

name

String

Definition:

Displayed name.

Value range:

N/A

operator

String

Definition:

Comparison operator.

Value range:

N/A

value

String

Definition:

Attribute value.

Value range:

N/A

value_type

String

Definition:

Data type.

Range:

• float: numeric type.

• string: string type.

is_valid

Boolean

Definition:

Valid or not.

Value range:

• true: valid.

• false: invalid.

id

String

Definition:

Rule template instance ID.

Value range:

N/A

name

String

Definition:

Rule template instance name.

Value range:

N/A

type

String

Definition:

Rule instance type.

Value range:

N/A

version

String

Definition:

Rule instance version.

Value range:

N/A

operator

String

Definition:

Latest operator of the rule instance.

Value range:

N/A

operate_time

Long

Definition:

Time when the rule was last operated.

Value range:

N/A

is_valid

Boolean

Definition:

Whether the rule instance takes effect.

Value range:

• true: The rule takes effect.

• false: The rule does not take effect.

level

String

Definition:

Effective level of a rule instance.

Value range:

N/A

is_public

Boolean

Definition:

Whether the rule instance is system-level.

Value range:

• true: The rule instance is system-level.

• false: The rule instance is not system-level.

is_legacy

Boolean

Definition:

Whether the rule instance data is from version 1.0.

Range:

• true: The rule instance data is from version 1.0.

• false: The rule instance data is not from version 1.0.

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