Help Center/ Config/ API Reference/ APIs/ Compliance/ Querying Compliance Summary by Rule

Updated on 2025-12-15 GMT+08:00

View PDF

Querying Compliance Summary by Rule

Function

This API is used to query compliance summary by rule ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states/summary

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies the account ID. Maximum: 36
policy_assignment_id	Yes	String	Specifies the rule ID. Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
resource_name	No	String	Specifies the resource name. Maximum: 256

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
compliance_state	String	Specifies the rule status.
policy_assignment	PolicyAssignment object	Specifies the rule.
results	PolicyComplianceSummaryResults object	Specifies the results of compliance summaries.

**Table 4** PolicyAssignment
Parameter	Type	Description
policy_assignment_type	String	Specifies the rule type, which can be builtin or custom.
id	String	Specifies the rule ID.
name	String	Specifies the rule name.
description	String	Specifies the rule description.
policy_filter	PolicyFilterDefinition object	Specifies the policy filter of a rule.
period	String	Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.
state	String	Specifies the rule status.
created	String	Specifies the time when the rule was added.
updated	String	Specifies the time when the rule was modified.
policy_definition_id	String	Specifies the ID of the policy associated with a rule.
custom_policy	CustomPolicy object	Specifies the custom rule.
parameters	Map<String,PolicyParameterValue>	Specifies rule parameters.
tags	Array of ResourceTag objects	Tags
created_by	String	Specifies the rule creator.
target_type	String	Execution method of remediation.
target_id	String	The ID of a remediation object.

**Table 5** PolicyFilterDefinition
Parameter	Type	Description
region_id	String	Specifies the region ID. Maximum: 128
resource_provider	String	Specifies the cloud service name. Maximum: 128
resource_type	String	Specifies the resource type. Maximum: 128
resource_id	String	Specifies the resource ID. Maximum: 512
tag_key	String	Specifies the tag key. Maximum: 128
tag_value	String	Specifies the tag value. Maximum: 256

**Table 6** CustomPolicy
Parameter	Type	Description
function_urn	String	Specifies the URN of a custom function. Maximum: 1024
auth_type	String	Specifies the method used by a custom rule to call a function.
auth_value	Map<String,Object>	Specifies the value of the method used by a custom rule to call a function.

**Table 7** PolicyParameterValue
Parameter	Type	Description
value	Object	Specifies the value of the rule parameter.

**Table 8** ResourceTag
Parameter	Type	Description
key	String	Tag key. A tag key can contain up to 128 Unicode characters and must comply with the character set specifications in section 3.1. Minimum: 1 Maximum: 128
value	String	Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2. Minimum: 0 Maximum: 255

**Table 9** PolicyComplianceSummaryResults
Parameter	Type	Description
resource_details	ResourceComplianceSummaryUnit object	Resource compliance summary details.
assignment_details	PolicyComplianceSummaryUnit object	Specifies the compliance summary details.

**Table 10** ResourceComplianceSummaryUnit
Parameter	Type	Description
compliant_count	Integer	Specifies the number of compliant resources.
non_compliant_count	Integer	Specifies the number of non-compliant resources.

**Table 11** PolicyComplianceSummaryUnit
Parameter	Type	Description
compliant_count	Integer	Specifies the number of compliant resources.
non_compliant_count	Integer	Specifies the number of non-compliant resources.

Status code: 400

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

None

Example Responses

Status code: 200

Operation successful.

{
  "compliance_state" : "NonCompliant",
  "policy_assignment" : {
    "policy_assignment_type" : "builtin",
    "id" : "68511e12374e70675172b9c1",
    "name" : "cts-obs-bucket-track2-Q2E4Mw",
    "description" : "The evaluation based on this rule is triggered upon configuration changes. Evaluation result: non-compliant; All CTS trackers in the account failed to track the specified OBS buckets.",
    "policy_filter" : {
      "region_id" : null,
      "resource_provider" : null,
      "resource_type" : null,
      "resource_id" : null,
      "tag_key" : null,
      "tag_value" : null
    },
    
    "period" : "TwentyFour_Hours",
    "state" : "Enabled",
    "created" : "2025-06-17T07:49:38.717Z",
    "updated" : "2025-06-17T07:49:38.717Z",
    "policy_definition_id" : "77982d0e4e8954e37d0f6919",
    "custom_policy" : null,
    "parameters" : {
      "trackBucket" : {
        "value" : "rms"
      }
    },
    "tags" : [ {
      "key" : "AAA",
      "value" : "AAA"
    } ],
    "created_by" : "ServiceLinkedAgencyForRMSConforms",
    "target_type" : null,
    "target_id" : null
  },
  "results" : {
    "resource_details" : {
      "compliant_count" : 0,
      "non_compliant_count" : 1
    },
    "assignment_details" : null
  }
}