查询规则列表中的所有规则。
接口说明
本文将提供一个示例，查询当前账号内的规则列表。返回结果显示，规则列表中规则总数为 1 条，评估资源数为 3 条，评估结果为 COMPLIANT（合规）。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| config:ListConfigRules | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ResourceTypes | string | 否 | 规则评估的资源类型。 | ACS::ECS::Instance |
| PageSize | integer | 否 | 分页时每页显示的数据行数。 取值范围：1~100。起始值：1。默认值：10。 | 10 |
| CompliancePackId | string | 否 | 合规包 ID。 | cp-fe416457e0d90022**** |
| ComplianceType | string | 否 | 规则合规评估结果。取值：
| COMPLIANT |
| PageNumber | integer | 否 | 页码。 起始值：1。默认值：1。 | 1 |
| Keyword | string | 否 | 查询关键字。 支持对规则 ID、规则名称、规则描述和规则模板标识等进行模糊查询。 | ecs |
| ConfigRuleState | string | 否 | 规则运行状态。取值：
| ACTIVE |
| ConfigRuleName | string | 否 | 规则名称。 | 弹性IP实例带宽满足最低要求 |
| RiskLevel | integer | 否 | 规则风险等级。取值：
| 1 |
返回参数
示例
正常返回示例
JSON格式
{
"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": "弹性IP实例可用带宽大于等于指定参数值，视为“合规”。默认值：10 MB。",
"CreateBy": {
"CompliancePackId": "cp-fdc8626622af00f9****",
"CompliancePackName": "等保三级预检合规包"
},
"AutomationType": "OOS",
"ConfigRuleName": "弹性IP实例带宽满足最低要求",
"ConfigRuleId": "cr-fdc8626622af00f9****",
"Tags": [
{
"Key": "env",
"Value": "prod"
}
],
"ResourceTypesScope": "ACS::EIP::EipAddress"
}
],
"PageSize": 10,
"PageNumber": 1,
"TotalCount": 1
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | NoPermission | You are not authorized to perform this operation. | 您无权执行此操作。 |
| 400 | Invalid.AggregatorId.Value | The specified AggregatorId is invalid. | 账号组ID不存在或无权限使用该账号组。 |
| 404 | AccountNotExisted | Your account does not exist. | - |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-06-04 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |