Obtaining Policy Details

Function

This API is used to obtain policy details.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
rule_set_id	Yes	String	Definition: Policy ID. Constraints: N/A Value range: N/A Default value: N/A
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cloud_project_id	No	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

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
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.

**Table 5** 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. 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

**Table 6** 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 7** 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.

**Table 8** RuleSet
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
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.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

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

Example Responses

Status code: 200

{
  "id" : "6e7cbaab83d74909b23b0ead6f5d7895",
  "name" : "NewPolicy-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" : "NewRule-20250617094444",
    "is_valid" : true,
    "version" : "3fa6f315958b41f7a3312cbd2d8ad0f1",
    "plugin_id" : "official_devcloud_codeCheck",
    "plugin_name" : "official_devcloud_codeCheck",
    "plugin_version" : "0.0.1",
    "content" : [ {
      "group_name" : "Check bug statistics",
      "can_modify_when_inherit" : true,
      "editable" : true,
      "properties" : [ {
        "key" : "codecheck.deadly",
        "type" : "judge",
        "name" : "Critical",
        "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"
  } ]
}