文档

ListAggregateConfigRules - 查询账号组的规则列表

更新时间:

查询指定账号组内的规则列表。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

规则运行状态。取值:

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

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

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

规则风险等级。取值:

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

规则名称。

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

账号组 ID。

关于如何获取账号组 ID,请参见 ListAggregators

ca-f632626622af0079****
PageSizeinteger

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

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

10
PageNumberinteger

页码。

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

1
Keywordstring

查询关键字。

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

ecs
ResourceTypesstring

规则评估的资源类型。

ACS::ECS::Instance

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

RequestIdstring

请求 ID。

22EF8287-2C9A-4F1F-80A6-CEFA7612689D
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****
AggregatorNamestring

账号组名称。

Test_Group
CompliancePackNamestring

合规包名称。

等保三级预检合规包
CreatorNamestring

创建规则的企业管理账号名称。

Alice
CreatorTypestring

创建规则的类型。仅支持 AGGREGATOR(账号组)。

AGGREGATOR
CreatorIdstring

创建规则的企业管理账号 ID。

100931896542****
AggregatorIdstring

账号组 D。

ca-f632626622af0079****
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": "22EF8287-2C9A-4F1F-80A6-CEFA7612689D",
  "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****",
          "AggregatorName": "Test_Group",
          "CompliancePackName": "等保三级预检合规包",
          "CreatorName": "Alice",
          "CreatorType": "AGGREGATOR",
          "CreatorId": "100931896542****",
          "AggregatorId": "ca-f632626622af0079****"
        },
        "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 返回结构发生变更
  • 本页导读 (1)
文档反馈