Help Center/ Config/ API Reference/ APIs/ Resource Aggregators/ Querying Aggregated Rules

Updated on 2024-07-10 GMT+08:00

View PDF

Querying Aggregated Rules

Function

This API is used to query aggregated rules. For a rule, the numbers of both compliant and non-compliant resources are included.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignments/compliance

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200
marker	No	String	Specifies the pagination parameter. Minimum: 4 Maximum: 400

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
aggregator_id	Yes	String	Specifies the resource aggregator ID. Minimum: 1 Maximum: 256
filter	No	AggregatePolicyAssignmentsFilters object	Specifies the filter of aggregated rules.

**Table 5** AggregatePolicyAssignmentsFilters
Parameter	Mandatory	Type	Description
account_id	No	String	Specifies the source account ID. Minimum: 1 Maximum: 36
compliance_state	No	String	Specifies the compliance result.
policy_assignment_name	No	String	Specifies the rule name. Maximum: 64

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
aggregate_policy_assignments	Array of AggregatePolicyAssignments objects	Specifies the aggregated rules.
page_info	PageInfo object	Specifies the pagination object.

**Table 7** AggregatePolicyAssignments
Parameter	Type	Description
policy_assignment_id	String	Specifies the rule ID
policy_assignment_name	String	Specifies the rule name.
compliance	Compliance object	Specifies the compliance of a rule.
account_id	String	Specifies the source account ID.
account_name	String	Account name

**Table 8** Compliance
Parameter	Type	Description
compliance_state	String	Specifies the compliance result.
resource_details	PolicyComplianceSummaryUnit object	Specifies the compliance summary details.

**Table 9** 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 10** 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 11** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**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

Querying aggregated rules

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignments/compliance

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f"
}

Example Responses

Status code: 200

Operation succeeded.

{
  "aggregate_policy_assignments" : [ {
    "policy_assignment_id" : "62bdbe5913c6836025b1e3af",
    "policy_assignment_name" : "volumes-encrypted-check",
    "compliance" : {
      "compliance_state" : "Compliant",
      "resource_details" : {
        "compliant_count" : 18,
        "non_compliant_count" : 0
      }
    },
    "account_id" : "789d4ac10eda4d9b8e090f5c2b1e4459",
    "account_name" : "demo1"
  }, {
    "policy_assignment_id" : "631ea13f57e0427679a1794d",
    "policy_assignment_name" : "cts-lts-enable",
    "compliance" : {
      "compliance_state" : "NonCompliant",
      "resource_details" : {
        "compliant_count" : 28,
        "non_compliant_count" : 2
      }
    },
    "account_id" : "83240c3f2ec1465aaa0124c87810ce65",
    "account_name" : "demo2"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3"
  }
}