Help Center> Config> API Reference> APIs> Resource Aggregators> Querying Aggregated Rules
Updated on 2024-04-18 GMT+08:00

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"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Querying aggregated rules

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.config.v1.region.ConfigRegion;
import com.huaweicloud.sdk.config.v1.*;
import com.huaweicloud.sdk.config.v1.model.*;


public class ListAggregateComplianceByPolicyAssignmentSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ConfigClient client = ConfigClient.newBuilder()
                .withCredential(auth)
                .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAggregateComplianceByPolicyAssignmentRequest request = new ListAggregateComplianceByPolicyAssignmentRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        AggregatePolicyAssignmentsRequest body = new AggregatePolicyAssignmentsRequest();
        body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f");
        request.withBody(body);
        try {
            ListAggregateComplianceByPolicyAssignmentResponse response = client.listAggregateComplianceByPolicyAssignment(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Querying aggregated rules

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkconfig.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = ConfigClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAggregateComplianceByPolicyAssignmentRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.body = AggregatePolicyAssignmentsRequest(
            aggregator_id="7ca3447830bd49c9b630a99680eaf90f"
        )
        response = client.list_aggregate_compliance_by_policy_assignment(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Querying aggregated rules

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := config.NewConfigClient(
        config.ConfigClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAggregateComplianceByPolicyAssignmentRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	request.Body = &model.AggregatePolicyAssignmentsRequest{
		AggregatorId: "7ca3447830bd49c9b630a99680eaf90f",
	}
	response, err := client.ListAggregateComplianceByPolicyAssignment(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

Authentication failed or you do not have the operation permissions.

500

Server error.

Error Codes

See Error Codes.