GetResourceComplianceByConfigRule API Overview - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

This topic provides an example on how to query the evaluation results of the rule cr-d369626622af008e**** for resources. The response shows that the total number of resources is 10, of which 5 are compliant.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:GetResourceComplianceByConfigRule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ComplianceType	string	No	The compliance evaluation result. Valid values: COMPLIANT: Compliant. NON_COMPLIANT: Non-compliant. NOT_APPLICABLE: Not applicable. INSUFFICIENT_DATA: No data. Valid values: NOT_APPLICABLE : Not applicable. COMPLIANT : Compliant. NON_COMPLIANT : Non-compliant. INSUFFICIENT_DATA : No data. IGNORED : Ignored.	COMPLIANT
ConfigRuleId	string	Yes	The rule ID. For information about how to obtain a rule ID, see ListConfigRules.	cr-d369626622af008e****

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
ComplianceResult	object	The evaluation result of the resources.
TotalCount	integer	The total number of evaluated resources.	10
Compliances	array<object>	The evaluation result of the resources.
	object
ComplianceType	string	The compliance evaluation result. Valid values: COMPLIANT: Compliant. NON_COMPLIANT: Non-compliant. NOT_APPLICABLE: Not applicable. INSUFFICIENT_DATA: No data.	COMPLIANT
Count	integer	The number of resources that match the evaluation result. For example, if `ComplianceType` is `COMPLIANT`, this parameter indicates the number of compliant resources.	5
RequestId	string	The request ID.	23306AB1-34E0-468F-BD7B-68D8AEAB753d

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	AccountNotExisted	Your account does not exist.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.