ListConfigRules - 查询规则列表_配置审计(CloudConfig)-阿里云帮助中心

查询当前账号规则列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:ListConfigRules

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ConfigRuleState	string	否	规则的状态。取值： ACTIVE：应用中。 EVALUATING：评估中。 INACTIVE：已停用。	ACTIVE
ComplianceType	string	否	规则的合规类型。取值： COMPLIANT：合规。 NON_COMPLIANT：不合规。 NOT_APPLICABLE：不适用。 INSUFFICIENT_DATA：数据不充分。	COMPLIANT
RiskLevel	integer	否	规则的风险等级。取值： 1：高风险。 2：中风险。 3：低风险。	1
PageNumber	integer	否	规则列表的页码。起始值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。取值范围：1~100。	20
MultiAccount	boolean	否	该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线，其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数，建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组，请参见账号组。	true
MemberId	integer	否	该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线，其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数，建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组，请参见账号组。	123456789
ConfigRuleName	string	否	规则的名称。	OSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问
CompliancePackId	string	否	规则所属的合规包 ID。	cp-8d5c6457e0d9002a****

返回参数

名称	类型	描述	示例值
	object	无。
ConfigRules	object	规则列表。
ConfigRuleList	array<object>	规则列表。
	object	无。
AccountId	integer	该规则归属的阿里云账号 ID。	987654321
AutomationType	string	修正模板类型。取值：LC。说明 LC：逻辑编排（Logic Composer）。	LC
Compliance	object	规则合规情况统计。
ComplianceType	string	规则合规类型。取值： COMPLIANT：合规。 NON_COMPLIANT：不合规。 NOT_APPLICABLE：不适用。 INSUFFICIENT_DATA：数据不充分。	COMPLIANT
Count	integer	该规则符合指定合规类型的资源数统计。	161
CompliancePackId	string	规则所属的合规包 ID。	cp-8d5c6457e0d9002a****
ConfigRuleArn	string	规则 ARN。	acs:config::120886317861**:rule/cr-8d5c6457e0d9002a**
ConfigRuleId	string	规则 ID。	cr-8d5c6457e0d9002a****
ConfigRuleName	string	规则名称。	OSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问
ConfigRuleState	string	当前规则运行状态。取值： ACTIVE：应用中。 EVALUATING：评估中。 INACTIVE：已停用。	ACTIVE
CreateBy	object	规则的创建信息。
CompliancePackId	string	合规包 ID。	cp-8d5c6457e0d9002a****
CompliancePackName	string	合规包名称。	OSS合规管理最佳实践
Description	string	规则的描述信息。	OSS存储空间的ACL策略禁止公共读访问，视为“合规”。
RiskLevel	integer	规则的风险等级。取值： 1：高风险。 2：中风险。 3：低风险。	1
SourceIdentifier	string	规则标识。如果规则使用了托管规则，则该参数为托管规则名称。如果规则使用了自定义函数，则该参数为函数 ARN。	oss-bucket-public-read-prohibited
SourceOwner	string	规则来源的归属。取值： CUSTOM_FC：用户自定义函数。 ALIYUN：托管规则。	ALIYUN
Tags	array<object>	标签。
	object	标签。
Key	string	标签键。	Key1
Value	string	标签值。	Value1
PageNumber	integer	规则列表的页码。起始值：1。	1
PageSize	integer	分页查询时设置的每页行数。取值范围：1~100。	20
TotalCount	integer	规则总数。	1
RequestId	string	请求 ID。	8195B664-9565-4685-89AC-8B5F04B44B92

示例

正常返回示例

JSON格式

{
  "ConfigRules": {
    "ConfigRuleList": [
      {
        "AccountId": 987654321,
        "AutomationType": "LC",
        "Compliance": {
          "ComplianceType": "COMPLIANT",
          "Count": 161
        },
        "CompliancePackId": "cp-8d5c6457e0d9002a****",
        "ConfigRuleArn": "acs:config::120886317861****:rule/cr-8d5c6457e0d9002a****",
        "ConfigRuleId": "cr-8d5c6457e0d9002a****",
        "ConfigRuleName": "OSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问",
        "ConfigRuleState": "ACTIVE",
        "CreateBy": {
          "CompliancePackId": "cp-8d5c6457e0d9002a****",
          "CompliancePackName": "OSS合规管理最佳实践"
        },
        "Description": "OSS存储空间的ACL策略禁止公共读访问，视为“合规”。",
        "RiskLevel": 1,
        "SourceIdentifier": "oss-bucket-public-read-prohibited",
        "SourceOwner": "ALIYUN",
        "Tags": [
          {
            "Key": "Key1",
            "Value": "Value1"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  },
  "RequestId": "8195B664-9565-4685-89AC-8B5F04B44B92"
}

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	You are not authorized to perform this operation.	您无权执行此操作。
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	服务不可用。

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

变更历史

更多信息，参考变更详情。