Help Center/ Config/ API Reference/ APIs/ Compliance/ Querying Resource Compliance Summary

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

View PDF

Querying Resource Compliance Summary

Function

This API is used to query resource compliance summary.

Calling Method

For details, see Calling APIs.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
resource_id	No	String	Specifies the resource ID. Maximum: 512
resource_name	No	String	Specifies the resource name. Maximum: 256
limit	No	Integer	Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200
marker	No	String	Specifies the pagination parameter. You can use the marker value in a subsequent call to request the next set of list items. Minimum: 4 Maximum: 400

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
value	Array of PolicyResourceComplianceSummary objects	Specifies the return value of querying the compliance result.
page_info	PageInfo object	Specifies the pagination object.

**Table 4** PolicyResourceComplianceSummary
Parameter	Type	Description
compliance_state	String	Specifies the rule status.
resource	PolicyResource object	Specifies the resource.
results	PolicyComplianceSummaryResults object	Specifies the results of compliance summaries.

**Table 5** PolicyResource
Parameter	Type	Description
resource_id	String	Specifies the resource ID.
resource_name	String	Specifies the resource name.
resource_provider	String	Specifies the cloud service name.
resource_type	String	Specifies the resource type.
region_id	String	Specifies the region ID.
domain_id	String	Specifies the ID of the user to which the resource belongs.

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

**Table 7** 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 8** PolicyComplianceSummaryUnit
Parameter	Type	Description
compliant_count	Integer	Specifies the number of compliant resources.
non_compliant_count	Integer	Specifies the number of non-compliant resources.

**Table 9** PageInfo
Parameter	Type	Description
current_count	Integer	Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200
next_marker	String	Specifies the marker value of the next page. Minimum: 4 Maximum: 400

Status code: 400

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

{
  "value" : [ {
    "compliance_state" : "NonCompliant",
    "resource" : {
      "resource_id" : "011414082b134059b1c5eafe0697cd15",
      "resource_name" : "ServiceLinkedAgencyForSecMaster",
      "resource_provider" : "iam",
      "resource_type" : "agencies",
      "region_id" : "global",
      "domain_id" : "e74e043fab784a45ad88f5ef6a4bcffc"
    },
    "results" : {
      "resource_details" : null,
      "assignment_details" : {
        "compliant_count" : null,
        "non_compliant_count" : 1
      }
    }
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}