ListConfigRules - Cloud Config - Alibaba Cloud Documentation Center

Queries the rules of the current account.

Operation description

This topic provides an example on how to query the rules of the current account. The response shows that the current account has a total of one rule and three evaluated resources. The resources 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.

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:ListConfigRules	List	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceTypes	string	No	The type of the resources to be evaluated based on the rule.	ACS::ECS::Instance
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. A minimum of 1 entry can be returned per page. Default value: 10.	10
ComplianceType	string	No	The compliance evaluation result of the rule. Valid values: COMPLIANT: The resources are evaluated as compliant. NON_COMPLIANT: The resources are evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to the resources. INSUFFICIENT_DATA: No resource data is available.	COMPLIANT
PageNumber	integer	No	The page number. Page numbers start from 1. Default value: 1.	1
Keyword	string	No	The query keyword. You can perform a fuzzy search by rule ID, rule name, rule description, or managed rule ID.	ecs
ConfigRuleState	string	No	The status of the rule. Valid values: ACTIVE: The rule is enabled. DELETING: The rule is being deleted. EVALUATING: The rule is being used to evaluate resource configurations. INACTIVE: The rule is disabled.	ACTIVE
ConfigRuleName	string	No	The name of the rule.	test-rule-name
RiskLevel	integer	No	The risk level of the resources that are not compliant with the rule. Valid values: 1: high 2: medium 3: low	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7
ConfigRules	object	The information about the rules.
ConfigRuleList	object []	The details of the rule.
RiskLevel	integer	The risk level of the resources that do not comply with the rule. Valid values: 1: high. 2: medium. 3: low.	1
SourceOwner	string	The type of the rule. Valid values: CUSTOM_FC: a custom rule. ALIYUN: a managed rule.	ALIYUN
AccountId	long	The ID of the account to which the rule belongs.	100931896542****
ConfigRuleState	string	The status of the rule. Valid values: ACTIVE: The rule is enabled. DELETING: The rule is being deleted. EVALUATING: The rule is being used to evaluate resource configurations. INACTIVE: The rule is disabled.	ACTIVE
Compliance	object	The compliance aggregation result of the rule.
ComplianceType	string	The compliance evaluation result of the rule. Valid values: COMPLIANT: The resources are evaluated as compliant. NON_COMPLIANT: The resources are evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to the resources. INSUFFICIENT_DATA: No resource data is available.	COMPLIANT
Count	integer	The number of resources that are evaluated based on the rule.	2
SourceIdentifier	string	The identifier of the rule. If the rule is a managed rule, the value of this parameter is the identifier of the managed rule. If the rule is a custom rule, the value of this parameter is the Alibaba Cloud Resource Name (ARN) of the rule.	eip-bandwidth-limit
ConfigRuleArn	string	The ARN of the rule.	acs:config::100931896542**:rule/cr-fdc8626622af00f9**
Description	string	The description of the rule.	The description of the test rule.
CreateBy	object	The information about the creation of the rule.
CompliancePackId	string	The compliance package ID.	cp-fdc8626622af00f9****
CompliancePackName	string	The name of the compliance package.	test-pack-name
AutomationType	string	The type of the remediation template. Only OOS is returned, which indicates CloudOps Orchestration Service.	OOS
ConfigRuleName	string	The name of the rule.	test-rule-name
ConfigRuleId	string	The rule ID.	cr-fdc8626622af00f9****
Tags	object []	The tags of the rule.
Key	string	The tag key of the rule.	env
Value	string	The tag value of the rule.	prod
ResourceTypesScope	string	The types of resources evaluated by the rule. Multiple resource types are separated with commas (,).	ACS::EIP::EipAddress
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	long	The total number of rules.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7",
  "ConfigRules": {
    "ConfigRuleList": [
      {
        "RiskLevel": 1,
        "SourceOwner": "ALIYUN",
        "AccountId": 0,
        "ConfigRuleState": "ACTIVE",
        "Compliance": {
          "ComplianceType": "COMPLIANT",
          "Count": 2
        },
        "SourceIdentifier": "eip-bandwidth-limit",
        "ConfigRuleArn": "acs:config::100931896542****:rule/cr-fdc8626622af00f9****",
        "Description": "The description of the test rule.",
        "CreateBy": {
          "CompliancePackId": "cp-fdc8626622af00f9****",
          "CompliancePackName": "test-pack-name"
        },
        "AutomationType": "OOS",
        "ConfigRuleName": "test-rule-name",
        "ConfigRuleId": "cr-fdc8626622af00f9****",
        "Tags": [
          {
            "Key": "env",
            "Value": "prod"
          }
        ],
        "ResourceTypesScope": "ACS::EIP::EipAddress"
      }
    ],
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.	The specified aggregator ID does not exist or you are not authorized to use the aggregator.
404	AccountNotExisted	Your account does not exist.	The specified 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.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-06-04

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 503
Output Parameters	The response structure of the API has changed.