全部产品
Search
文档中心

配置审计:ListConfigRules - 查询规则列表

更新时间:Jun 19, 2024

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:ListConfigRulesList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceTypesstring

规则评估的资源类型。

ACS::ECS::Instance
PageSizeinteger

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

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

10
ComplianceTypestring

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

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:无数据。
COMPLIANT
PageNumberinteger

页码。

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

1
Keywordstring

查询关键字。

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

ecs
ConfigRuleStatestring

规则运行状态。取值:

  • ACTIVE:应用中。
  • DELETING:删除中。
  • EVALUATING:评估中。
  • INACTIVE:已停用。
ACTIVE
ConfigRuleNamestring

规则名称。

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

规则风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7
ConfigRulesobject

规则列表。

ConfigRuleListobject []

规则列表详细信息。

RiskLevelinteger

规则风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
SourceOwnerstring

规则来源的归属。取值:

  • CUSTOM_FC:自定义规则。
  • ALIYUN:规则模板。
ALIYUN
AccountIdlong

规则归属的账号 ID。

100931896542****
ConfigRuleStatestring

规则运行状态。取值:

  • ACTIVE:应用中。
  • DELETING:删除中。
  • EVALUATING:评估中。
  • INACTIVE:已停用。
ACTIVE
Complianceobject

规则的合规聚合结果。

ComplianceTypestring

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

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:无数据。
COMPLIANT
Countinteger

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

2
SourceIdentifierstring

规则标识符。

  • 如果是规则模板,该参数为规则模板标识。
  • 如果是自定义规则,该参数为函数 ARN。
eip-bandwidth-limit
ConfigRuleArnstring

规则 ARN。

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

规则描述。

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

创建规则的信息。

CompliancePackIdstring

合规包 ID。

cp-fdc8626622af00f9****
CompliancePackNamestring

合规包名称。

等保三级预检合规包
AutomationTypestring

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

OOS
ConfigRuleNamestring

规则名称。

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

规则 ID。

cr-fdc8626622af00f9****
Tagsobject []

规则的标签。

Keystring

规则的标签键。

env
Valuestring

规则的标签值。

prod
ResourceTypesScopestring

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

ACS::EIP::EipAddress
PageSizeinteger

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

10
PageNumberinteger

页码。

1
TotalCountlong

规则总数。

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错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.账号组ID不存在或无权限使用该账号组。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

变更历史

变更时间变更内容概要操作
2023-06-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:503
出参OpenAPI 返回结构发生变更