ListConfigRules - 查询规则列表

查询规则列表中的所有规则。

接口说明

本文将提供一个示例,查询当前账号内的规则列表。返回结果显示,规则列表中规则总数为 1 条,评估资源数为 3 条,评估结果为 COMPLIANT(合规)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:ListConfigRules

list

*Rule

acs:config:*:{#accountId}:rule/*

请求参数

名称

类型

必填

描述

示例值

ResourceTypes

string

规则评估的资源类型。

ACS::ECS::Instance

PageSize

integer

分页时每页显示的数据行数。

取值范围:1~100。起始值:1。默认值:10。

10

CompliancePackId

string

合规包 ID。

cp-fe416457e0d90022****

ComplianceType

string

规则合规评估结果。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

COMPLIANT

PageNumber

integer

页码。

起始值:1。默认值:1。

1

Keyword

string

查询关键字。

支持对规则 ID、规则名称、规则描述和规则模板标识等进行模糊查询。

ecs

ConfigRuleState

string

规则运行状态。取值:

  • ACTIVE:应用中。

  • DELETING:删除中。

  • EVALUATING:评估中。

  • INACTIVE:已停用。

ACTIVE

ConfigRuleName

string

规则名称。

弹性IP实例带宽满足最低要求

RiskLevel

integer

规则风险等级。取值:

  • 1:高风险。

  • 2:中风险。

  • 3:低风险。

1

SortBy

string

默认不传值。当前支持:CreateDate-Desc,代表新创建的规则排序靠前。

CreateDate-Desc

Tag

array<object>

资源的标签。

最多支持绑定 20 个标签。

object

资源的标签。

最多支持绑定 20 个标签。

Key

string

标签键

key-1

Value

string

标签值。

value-1

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7

ConfigRules

object

规则列表。

ConfigRuleList

array<object>

规则列表详细信息。

object

规则列表详细信息。

RiskLevel

integer

规则风险等级。取值:

  • 1:高风险。

  • 2:中风险。

  • 3:低风险。

1

SourceOwner

string

规则来源的归属。取值:

  • CUSTOM_FC:自定义规则。

  • ALIYUN:规则模板。

ALIYUN

AccountId

integer

规则归属的账号 ID。

100931896542****

ConfigRuleState

string

规则运行状态。取值:

  • ACTIVE:应用中。

  • DELETING:删除中。

  • EVALUATING:评估中。

  • INACTIVE:已停用。

ACTIVE

Compliance

object

规则的合规聚合结果。

ComplianceType

string

规则合规评估的摘要结果。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

COMPLIANT

Count

integer

规则评估的摘要结果对应的评估数量。

2

SourceIdentifier

string

规则标识符。

  • 如果是规则模板,该参数为规则模板标识。

  • 如果是自定义规则,该参数为函数 ARN。

eip-bandwidth-limit

ConfigRuleArn

string

规则 ARN。

acs:config::100931896542****:rule/cr-fdc8626622af00f9****

Description

string

规则描述。

弹性IP实例可用带宽大于等于指定参数值,视为“合规”。默认值:10 MB。

CreateBy

object

创建规则的信息。

CompliancePackId

string

合规包 ID。

cp-fdc8626622af00f9****

CompliancePackName

string

合规包名称。

等保三级预检合规包

AutomationType

string

修正类型。仅支持 OOS(运维编排)。

OOS

ConfigRuleName

string

规则名称。

弹性IP实例带宽满足最低要求

ConfigRuleId

string

规则 ID。

cr-fdc8626622af00f9****

Tags

array<object>

规则的标签。

object

规则的标签。

Key

string

规则的标签键。

env

Value

string

规则的标签值。

prod

ResourceTypesScope

string

规则评估的资源类型,多个资源类型用半角逗号(,)分隔。

ACS::EIP::EipAddress

CreateDate

string

规则创建时间(UTC+8)

2025-09-19T15:51:00

PageSize

integer

分页时每页显示的数据行数。

10

PageNumber

integer

页码。

1

TotalCount

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",
        "CreateDate": "2025-09-19T15:51:00"
      }
    ],
    "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. 服务不可用。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情