文档首页/ 配置审计 Config/ API参考/ API/ 资源聚合器/ 查询聚合合规规则列表
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

查询聚合合规规则列表

功能介绍

查询合规和不合规规则的列表，其中包含合规和不合规规则的资源数量。

调用方法

请参见如何调用API。

URI

POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignments/compliance

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

账号ID。

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

最大的返回数量。

最小值：1

最大值：200

缺省值：200

marker

否

String

分页参数，通过上一个请求中返回的marker信息作为输入，获取当前页。

最小长度：4

最大长度：400

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。
表4 请求Body参数

参数

是否必选

参数类型

描述

aggregator_id

是

String

资源聚合器ID

最小长度：1

最大长度：256

filter

否

AggregatePolicyAssignmentsFilters object

聚合合规规则过滤器。
表5 AggregatePolicyAssignmentsFilters

参数

是否必选

参数类型

描述

account_id

否

String

源账号ID。

最小长度：1

最大长度：36

compliance_state

否

String

合规结果。

policy_assignment_name

否

String

合规规则名称

最大长度：64

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

aggregate_policy_assignments

Array of AggregatePolicyAssignments objects

聚合合规规则的列表。

page_info

PageInfo object

分页对象。
表7 AggregatePolicyAssignments

参数

参数类型

描述

policy_assignment_id

String

合规规则ID

policy_assignment_name

String

合规规则名称

compliance

Compliance object

合规规则合规性

account_id

String

源账号ID。

account_name

String

账号名称。
表8 Compliance

参数

参数类型

描述

compliance_state

String

合规结果。

resource_details

PolicyComplianceSummaryUnit object

规则总结详情。
表9 PolicyComplianceSummaryUnit

参数

参数类型

描述

compliant_count

Integer

合规数量。

non_compliant_count

Integer

不合规数量。
表10 PageInfo

参数

参数类型

描述

current_count

Integer

当前页的资源数量。

最小值：0

最大值：200

next_marker

String

下一页的marker。

最小长度：4

最大长度：400

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

查询聚合合规规则的列表

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignments/compliance

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f"
}

响应示例

状态码： 200

操作成功。

{
  "aggregate_policy_assignments" : [ {
    "policy_assignment_id" : "62bdbe5913c6836025b1e3af",
    "policy_assignment_name" : "volumes-encrypted-check",
    "compliance" : {
      "compliance_state" : "Compliant",
      "resource_details" : {
        "compliant_count" : 18,
        "non_compliant_count" : 0
      }
    },
    "account_id" : "789d4ac10eda4d9b8e090f5c2b1e4459",
    "account_name" : "demo1"
  }, {
    "policy_assignment_id" : "631ea13f57e0427679a1794d",
    "policy_assignment_name" : "cts-lts-enable",
    "compliance" : {
      "compliance_state" : "NonCompliant",
      "resource_details" : {
        "compliant_count" : 28,
        "non_compliant_count" : 2
      }
    },
    "account_id" : "83240c3f2ec1465aaa0124c87810ce65",
    "account_name" : "demo2"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3"
  }
}

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户认证失败或无操作权限。

500

服务器内部错误。

错误码

请参见错误码。

父主题： 资源聚合器

相关文档