All Products
Search
Document Center

Cloud Config:DescribeComplianceSummary

Last Updated:Jul 02, 2025

Queries the summary of compliance evaluations of the current Alibaba Cloud account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribeComplianceSummaryget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MultiAccountbooleanNo

This parameter is scheduled to be removed before 00:00:00, June 30, 2021. Account group-related APIs will be provided as an alternative before 00:00:00, May 30, 2021. If you are using this parameter, we recommend that you switch to account group-related APIs after 00:00:00, May 30, 2021. For more information, see Account groups.

false
MemberIdlongNo

This parameter is scheduled to be removed before 00:00:00, June 30, 2021. Account group-related APIs will be provided as an alternative before 00:00:00, May 30, 2021. If you are using this parameter, we recommend that you switch to account group-related APIs after 00:00:00, May 30, 2021. For more information, see Account groups.

123456789

Response parameters

ParameterTypeDescriptionExample
object
ComplianceSummaryobject

The summary of compliance evaluations.

ComplianceSummaryByConfigRuleobject

The summary of compliance evaluations from the rule dimension.

ComplianceSummaryTimestamplong

The timestamp when the summary was recorded.

1589853712165
CompliantCountinteger

The number of rules whose evaluation results are compliant.

111
NonCompliantCountinteger

The number of rules whose evaluation results are non-compliant.

12
TotalCountlong

The total number of rules.

123
ComplianceSummaryByResourceobject

The summary of compliance evaluations from the resource dimension.

ComplianceSummaryTimestamplong

The timestamp when the summary was recorded.

1589853712165
CompliantCountinteger

The number of resources evaluated as compliant.

1
NonCompliantCountinteger

The number of resources evaluated as non-compliant.

12
TotalCountlong

The total number of resources.

13
RequestIdstring

The ID of the request.

CAEE6F34-DEDC-4AAA-AA8C-946D5D008735

Examples

Sample success responses

JSONformat

{
  "ComplianceSummary": {
    "ComplianceSummaryByConfigRule": {
      "ComplianceSummaryTimestamp": 1589853712165,
      "CompliantCount": 111,
      "NonCompliantCount": 12,
      "TotalCount": 123
    },
    "ComplianceSummaryByResource": {
      "ComplianceSummaryTimestamp": 1589853712165,
      "CompliantCount": 1,
      "NonCompliantCount": 12,
      "TotalCount": 13
    }
  },
  "RequestId": "CAEE6F34-DEDC-4AAA-AA8C-946D5D008735"
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
404AccountNotExistedYour 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.