All Products
Search
Document Center

Cloud Config:GetAggregateResourceComplianceByConfigRule

Last Updated:Mar 01, 2024

Queries compliance evaluation results based on the rules in a compliance package in an account group.

Operation description

This topic provides an example on how to query the compliance evaluation results based on the cr-d369626622af008e**** rule in the ca-a4e5626622af0079**** account group. The returned result shows that a total of 10 resources are evaluated by the rule and five of them are evaluated as compliant.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetAggregateResourceComplianceByConfigRuleRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ComplianceTypestringNo

The compliance evaluation result of the resources. Valid values:

  • COMPLIANT: The resource is evaluated as compliant.
  • NON_COMPLIANT: The resource is evaluated as incompliant.
  • NOT_APPLICABLE: The rule does not apply to your resources.
  • INSUFFICIENT_DATA: No resource data is available.
COMPLIANT
ConfigRuleIdstringYes

The ID of the rule.

For more information about how to obtain the ID of a rule, see ListAggregateConfigRules .

cr-d369626622af008e****
AggregatorIdstringYes

The ID of the account group.

For more information about how to obtain the ID of the account group, see ListAggregators .

ca-a4e5626622af0079****
ResourceAccountIdlongNo

The ID of the Alibaba Cloud account to which the resources in the account group belong.

Note You can use either the ResourceAccountId or ResourceOwnerId parameter. We recommend that you use the ResourceAccountId parameter.
100931896542****

Response parameters

ParameterTypeDescriptionExample
object

N/A.

ComplianceResultobject

The compliance result.

TotalCountlong

The total number of evaluated resources.

5
Compliancesobject []

The compliance list result.

ComplianceTypestring

The compliance evaluation results of the resources. Valid values:

  • COMPLIANT: The resource was evaluated as compliant.
  • NON_COMPLIANT: The resource was evaluated as incompliant.
  • NOT_APPLICABLE: The rule did not apply to your resources.
  • INSUFFICIENT_DATA: No resource data was available.
COMPLIANT
Countinteger

The number of resources that have compliance evaluation results. For example, if the value of the ComplianceType parameter is COMPLIANT, this parameter value indicates the number of compliant resources.

3
RequestIdstring

The request ID.

23306AB1-34E0-468F-BD7B-68D8AEAB754C

Examples

Sample success responses

JSONformat

{
  "ComplianceResult": {
    "TotalCount": 5,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 3
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB754C"
}

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.

Change history

Change timeSummary of changesOperation
2023-04-12The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceAccountId