All Products
Search
Document Center

Cloud Config:GetAggregateResourceComplianceGroupByRegion

Last Updated:Jun 17, 2024

Queries the evaluation results grouped by resource type for an account group rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdsstringYes

The rule IDs. Separate multiple rule IDs with commas (,).

cr-2652626622af005e****
AggregatorIdstringYes

The ID of the account group.

ca-d6c9626622af0052****

Response parameters

ParameterTypeDescriptionExample
object
ComplianceResultobject

The queried evaluation results.

ComplianceResultListobject []

The evaluation results grouped by region.

RegionIdstring

The region ID of the evaluated resource.

cn-beijing
Compliancesobject []

The queried evaluation results.

ComplianceTypestring

The evaluation result. Valid values:

  • COMPLIANT: The resource is evaluated as compliant.
  • NON_COMPLIANT: The resource is evaluated as non-compliant.
  • NOT_APPLICABLE: The rule does not apply to the resource.
  • INSUFFICIENT_DATA: No data is available.
COMPLIANT
Countlong

The total number of evaluation results.

1
RequestIdstring

The request ID.

5E3A847A-5D40-54A1-A2CE-77A87823ED07

Examples

Sample success responses

JSONformat

{
  "ComplianceResult": {
    "ComplianceResultList": [
      {
        "RegionId": "cn-beijing",
        "Compliances": [
          {
            "ComplianceType": "COMPLIANT",
            "Count": 1
          }
        ]
      }
    ]
  },
  "RequestId": "5E3A847A-5D40-54A1-A2CE-77A87823ED07"
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.