All Products
Search
Document Center

Cloud Config:GetAggregateConfigRuleComplianceByPack

Last Updated:Mar 01, 2024

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

Operation description

The sample request in this topic shows you how to query the compliance evaluation results based on rules in the cp-541e626622af0087**** compliance package that is created for the ca-04b3fd170e340007**** account group. The return result shows a total of one rule. No resources are evaluated as non-compliant based on the rule.

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:GetAggregateConfigRuleComplianceByPackRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CompliancePackIdstringYes

The ID of the compliance package.

For information about how to obtain the ID of a compliance package, see ListAggregateCompliancePacks .

cp-541e626622af0087****
AggregatorIdstringYes

The ID of the account group.

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

ca-04b3fd170e340007****

For information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C6B0C0A8-3245-48F1-AEAB-BC1A446E99D0
ConfigRuleComplianceResultobject

The compliance evaluation results that are returned by rules in the compliance package.

CompliancePackIdstring

The ID of the compliance package.

cp-541e626622af0087****
NonCompliantCountinteger

The number of rules against which specific resources are evaluated as non-compliant.

0
ConfigRuleCompliancesobject []

The information about rules in the compliance package.

ComplianceTypestring

The compliance evaluation result returned by the rule. Valid values:

  • COMPLIANT: The relevant resources are evaluated as compliant.
  • NON_COMPLIANT: The relevant resources are evaluated as non-compliant.
  • NOT_APPLICABLE: The rule does not apply to your resources.
  • INSUFFICIENT_DATA: No resource data is available.
COMPLIANT
ConfigRuleNamestring

The name of the rule.

test-rule-name
ConfigRuleIdstring

The ID of the rule.

cr-fdc8626622af00f9****
TotalCountinteger

The total number of rules in the compliance package.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "C6B0C0A8-3245-48F1-AEAB-BC1A446E99D0",
  "ConfigRuleComplianceResult": {
    "CompliancePackId": "cp-541e626622af0087****",
    "NonCompliantCount": 0,
    "ConfigRuleCompliances": [
      {
        "ComplianceType": "COMPLIANT",
        "ConfigRuleName": "test-rule-name",
        "ConfigRuleId": "cr-fdc8626622af00f9****"
      }
    ],
    "TotalCount": 1
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.CompliancePackId.ValueThe specified CompliancePackId does not exist.The specified compliance pack ID does not exist.
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.