文档首页/ 配置审计 Config/ API参考（吉隆坡区域）/ API/ 资源聚合器/ 查询指定聚合合规规则详情
更新时间：2026-08-24 GMT+08:00
查看PDF
分享

查询指定聚合合规规则详情

功能介绍

查询指定聚合合规规则的详情。

调用方法

请参见如何调用API。

URI

POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignment/detail

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

账号ID。

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

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

参数

是否必选

参数类型

描述

aggregator_id

是

String

资源聚合器ID

最小长度：1

最大长度：256

account_id

是

String

源账号ID

最小长度：1

最大长度：36

policy_assignment_id

是

String

合规规则ID

最大长度：36

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

policy_assignment_type

String

规则类型，包括预定义合规规则(builtin)和用户自定义合规规则(custom)

id

String

规则ID。

name

String

规则名称。

description

String

规则描述。

policy_filter

PolicyFilterDefinition object

规则过滤器。

policy_filter_v2

PolicyFilterDefinitionV2 object

规则过滤器

period

String

周期值，可选值：One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

state

String

规则状态。

created

String

规则创建时间。

updated

String

规则更新时间。

policy_definition_id

String

规则的策略ID。

custom_policy

CustomPolicy object

自定义合规规则

parameters

Map<String,PolicyParameterValue>

规则参数。

tags

Array of ResourceTag objects

标签

created_by

String

规则的创建者

target_type

String

合规规则修正方式。

target_id

String

修正执行的目标id。
表5 PolicyFilterDefinition

参数

参数类型

描述

region_id

String

区域ID。

最大长度：128

resource_provider

String

云服务名称。

最大长度：128

resource_type

String

资源类型。

最大长度：128

resource_id

String

资源ID。

最大长度：512

tag_key

String

标签键。

最大长度：128

tag_value

String

标签值。

最大长度：256
表6 PolicyFilterDefinitionV2

参数

参数类型

描述

region_ids

Array of strings

区域ID列表

resource_types

Array of strings

云服务列表

resource_ids

Array of strings

资源ID列表

tag_key_logic

String

参数tags的取值逻辑，例如tags设置了a:a和b:b，当取值AND时，表示规则仅对同时绑定了a:a和b:b的资源生效；当取值为OR时，表示规则对任何绑定了a:a或b:b的资源生效。

缺省值：OR

tags

Array of FilterTagDetail objects

生效标签列表

exclude_tag_key_logic

String

参数exclude_tags的取值逻辑，例如exclude_tags设置了a:a和b:b，当取值AND时，表示规则仅对同时绑定了a:a和b:b的资源生效；当取值为OR时，表示规则对任何绑定了a:a或b:b的资源生效。

缺省值：OR

exclude_tags

Array of FilterTagDetail objects

排除标签列表，排除标签列表比生效标签列表有更高的优先级
表7 FilterTagDetail

参数

参数类型

描述

key

String

标签key

values

Array of strings

标签值列表
表8 CustomPolicy

参数

参数类型

描述

function_urn

String

自定义函数的URN

最大长度：1024

auth_type

String

自定义合规规则调用function方式

auth_value

Map<String,Object>

自定义合规规则调用function方式的参数值
表9 PolicyParameterValue

参数

参数类型

描述

value

Object

规则参数值。
表10 ResourceTag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。 key符合3.1 KEY字符集规范。

最小长度：1

最大长度：128

value

String

值。每个值最大长度255个unicode字符。value符合3.2 VALUE字符集规范。

最小长度：0

最大长度：255

状态码： 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-assignment/detail

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "account_id" : "39f4a9434e0c4bf3806e5aff54adea39",
  "policy_assignment_id" : "64104fff86952b3af614cabb"
}

响应示例

状态码： 200

操作成功。

{
  "policy_assignment_type" : "builtin",
  "id" : "64104fff86952b3af614cabb",
  "name" : "required-tag-check",
  "description" : "指定一个标签，不具有此标签的资源，视为“不合规”",
  "policy_filter" : {
    "region_id" : null,
    "resource_provider" : null,
    "resource_type" : null,
    "resource_id" : null,
    "tag_key" : null,
    "tag_value" : null
  },
  "period" : null,
  "state" : "Enabled",
  "created" : "2023-04-03T06:40:12.846Z",
  "updated" : "2023-04-03T06:40:12.846Z",
  "policy_definition_id" : "5fa9f89b6eed194ccb2c04db",
  "created_by" : "customer"
}

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

500

服务器内部错误。

错误码

请参见错误码。

父主题： 资源聚合器