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
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 Resourcesis 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 |
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 |
| CompliancePackId | string | No | The compliance package ID. For more information about how to obtain the ID of a compliance package, see ListCompliancePacks . Note
You must configure either the CompliancePackId or ConfigRuleId parameter.
| cp-fe416457e0d90022**** |
| ComplianceType | string | No | The compliance evaluation result of the rule. Valid values:
| 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 |
| 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 |
| Tag | array<object> | No | The tags of the resource. You can add up to 20 tags to a resource. | |
| object | No | The tags of the resource. You can add up to 20 tags to a resource. | ||
| Key | string | No | The tag key. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with You can specify at most 20 tag keys. | key-1 |
| Value | string | No | The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The tag value must start with a letter but cannot start with | value-1 |
Response parameters
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. | - |
| 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 | View Change Details |