GetComplianceSummary - Cloud Config - Alibaba Cloud Documentation Center

Queries the summary of compliance statistics within the current account.

Operation description

This topic provides an example on how to query the compliance statistics of resources and rules in the current account group.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
config:GetComplianceSummary	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	CAEE6F34-DEDC-4BAA-AA8C-946D5D008737
ComplianceSummary	object	The summary of compliance statistics.
ComplianceSummaryByResource	object	The summary of compliance statistics from the resource dimension.
CompliantCount	integer	The number of resources evaluated as compliant.	1
NonCompliantCount	integer	The number of resources evaluated as non-compliant.	12
ComplianceSummaryTimestamp	long	The time when the compliance summary was generated. Unit: milliseconds.	1589853712165
TotalCount	long	The total number of resources.	13
ComplianceSummaryByConfigRule	object	The summary of compliance statistics from the rule dimension.
CompliantCount	integer	The number of rules evaluated as compliant.	5
NonCompliantCount	integer	The number of rules evaluated as non-compliant.	11
ComplianceSummaryTimestamp	long	The time when the compliance summary was generated. Unit: milliseconds.	1589853712165
TotalCount	long	The total number of rules.	16

Examples

Sample success responses

JSONformat

{
  "RequestId": "CAEE6F34-DEDC-4BAA-AA8C-946D5D008737",
  "ComplianceSummary": {
    "ComplianceSummaryByResource": {
      "CompliantCount": 1,
      "NonCompliantCount": 12,
      "ComplianceSummaryTimestamp": 1589853712165,
      "TotalCount": 13
    },
    "ComplianceSummaryByConfigRule": {
      "CompliantCount": 5,
      "NonCompliantCount": 11,
      "ComplianceSummaryTimestamp": 1589853712165,
      "TotalCount": 16
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
503	ServiceUnavailable	The 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.