Querying the Details of a Policy

Function

This API is used to query the details of a policy.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
cloudProjectId	Yes	String	Project ID.
ruleSetId	Yes	String	Policy ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
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
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.
creator	String	Definition Policy creator. Range N/A
create_time	String	Definition Policy creation time. Range N/A
updater	String	Definition User who last updated the policy. Range N/A
update_time	String	Definition Time when the policy was last updated. Range N/A
rule_instances	Array of RuleInstance objects	Definition Rule instance set. Range N/A

**Table 3** RuleInstance
Parameter	Type	Description
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. Available only for inherited project-level policies. 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

**Table 4** RuleInstanceContent
Parameter	Type	Description
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

**Table 5** RuleInstanceProperty
Parameter	Type	Description
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.

Example Requests

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

Example Responses

Status code: 200

Response body for querying policy details.

{
  "id" : "842cacd3424a470eb410300b537fa756",
  "name" : "New policy-20240625194201",
  "level" : "project",
  "version" : "efaddbfff5c742f781802004b888eccb",
  "is_valid" : true,
  "is_public" : false
}