文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 查询用户的合规总结 - CollectPolicyStatesSummary
更新时间:2026-05-12 GMT+08:00
分享

查询用户的合规总结 - CollectPolicyStatesSummary

功能介绍

查询用户的合规总结

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    rms:policyStates:get

    Read

    policyAssignments

    g:ResourceTag/<tag-key>

    -

    -

URI

GET /v1/resource-manager/domains/{domain_id}/policy-states/summary

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

账号ID。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符。

默认取值

不涉及

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

tags

Array of strings

参数解释

标签列表

约束限制

标签格式为key或key=value

数组长度:1 - 5

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

results

PolicyComplianceSummaryResults object

参数解释

合规总结结果。

约束限制

不涉及

policy_assignments

Array of PolicyAssignmentComplianceSummary objects

参数解释

规则合规总结列表。

表4 PolicyAssignmentComplianceSummary

参数

参数类型

描述

compliance_state

String

参数解释

合规结果。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

policy_assignment

PolicyAssignment object

参数解释

规则。

results

PolicyComplianceSummaryResults object

参数解释

合规总结结果。

约束限制

不涉及

表5 PolicyAssignment

参数

参数类型

描述

policy_assignment_type

String

参数解释

规则类型。

取值范围

  • builtin:预定义合规规则

  • custom:自定义合规规则

id

String

参数解释

规则ID。

取值范围

不涉及

name

String

参数解释

规则名称。

取值范围

不涉及

description

String

参数解释

规则描述。

取值范围

不涉及

policy_filter

PolicyFilterDefinition object

参数解释

合规规则仅评估满足以下条件的资源,该字段已不推荐使用,推荐使用PolicyFilterDefinitionV2字段。

约束限制

PolicyFilterDefinition与PolicyFilterDefinitionV2字段互斥,不允许同时传参。

默认取值

不涉及

policy_filter_v2

PolicyFilterDefinitionV2 object

参数解释

合规规则仅评估满足以下条件的资源,与PolicyFilterDefinition字段相比,支持更灵活的资源过滤条件。

约束限制

PolicyFilterDefinition与PolicyFilterDefinitionV2字段互斥,不允许同时传参。

默认取值

不涉及

period

String

参数解释

周期值

取值范围

  • One_Hour:1小时

  • Three_Hours:3小时

  • Six_Hours:6小时

  • Twelve_Hours:12小时

  • TwentyFour_Hours:24小时

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

参数解释

合规规则修正方式。

取值范围

  • fgs:函数工作流

  • rfs:资源编排服务

target_id

String

参数解释

修正执行的目标id。

取值范围

不涉及

表6 PolicyFilterDefinition

参数

参数类型

描述

region_id

String

参数解释

区域ID。

约束限制

不涉及

取值范围

长度为[1~128]个字符。

默认取值

不涉及

最大长度:128

resource_provider

String

参数解释

云服务名称。

约束限制

不涉及

取值范围

长度为[1~128]个字符。

默认取值

不涉及

最大长度:128

resource_type

String

参数解释

资源类型。

约束限制

不涉及

取值范围

长度为[1~128]个字符。

默认取值

不涉及

最大长度:128

resource_id

String

参数解释

资源ID。

约束限制

不涉及

取值范围

长度为[1~512]个字符。

默认取值

不涉及

最大长度:512

tag_key

String

参数解释

标签键。

约束限制

不涉及

取值范围

长度为[1~128]个字符。

默认取值

不涉及

最大长度:128

tag_value

String

参数解释

标签值。

约束限制

不涉及

取值范围

长度为[1~256]个字符。

默认取值

不涉及

最大长度:256

表7 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的资源生效。

约束限制

不涉及

取值范围

  • AND:与

  • OR:或

默认取值

OR

缺省值: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的资源生效。

约束限制

不涉及

取值范围

  • AND:与

  • OR:或

默认取值

OR

缺省值:OR

exclude_tags

Array of FilterTagDetail objects

参数解释

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

约束限制

不涉及

表8 FilterTagDetail

参数

参数类型

描述

key

String

参数解释

标签key

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

values

Array of strings

参数解释

标签值列表

约束限制

不涉及

表9 CustomPolicy

参数

参数类型

描述

function_urn

String

参数解释

自定义函数的URN,可以在FunctionGraph服务函数列表获取

约束限制

不涉及

取值范围

长度为[1~1024]个字符

默认取值

不涉及

最大长度:1024

auth_type

String

参数解释

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

约束限制

不涉及

取值范围

  • agency:自定义委托

  • serviceLinkedAgency:服务关联委托

默认取值

不涉及

auth_value

Map<String,Object>

参数解释

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

约束限制

不涉及

表10 PolicyParameterValue

参数

参数类型

描述

value

Object

参数解释

规则参数值。

约束限制

不涉及

表11 ResourceTag

参数

参数类型

描述

key

String

参数解释

标签键。

约束限制

key符合3.1 KEY字符集规范。

取值范围

长度为[1-128]个unicode字符。

默认取值

不涉及

最小长度:1

最大长度:128

value

String

参数解释

标签值。

约束限制

value符合3.2 VALUE字符集规范。

取值范围

长度为[0-255]个unicode字符。

默认取值

不涉及

最小长度:0

最大长度:255

表12 PolicyComplianceSummaryResults

参数

参数类型

描述

resource_details

ResourceComplianceSummaryUnit object

参数解释

当前账号下合规与不合规的资源数量

约束限制

不涉及

assignment_details

PolicyComplianceSummaryUnit object

参数解释

当前账号下合规与不合规的规则数量

约束限制

不涉及

表13 ResourceComplianceSummaryUnit

参数

参数类型

描述

compliant_count

Integer

参数解释

合规的资源数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

non_compliant_count

Integer

参数解释

不合规的资源数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表14 PolicyComplianceSummaryUnit

参数

参数类型

描述

compliant_count

Integer

参数解释

合规的规则数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

non_compliant_count

Integer

参数解释

不合规的规则数量。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:403

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:404

表17 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:500

表18 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

请求示例

响应示例

状态码:200

Query results

{
  "results" : {
    "resource_details" : {
      "compliant_count" : 503,
      "non_compliant_count" : 527
    },
    "assignment_details" : {
      "compliant_count" : 1,
      "non_compliant_count" : 1
    }
  },
  "policy_assignments" : [ {
    "compliance_state" : "NonCompliant",
    "policy_assignment" : {
      "policy_assignment_type" : "builtin",
      "id" : "68511e12374e70675172b9c1",
      "name" : "cts-obs-bucket-track2-Q2E4Mw",
      "description" : "配置变更:帐号下的所有CTS追踪器未追踪指定的OBS桶,视为“不合规”",
      "policy_filter" : {
        "region_id" : null,
        "resource_provider" : null,
        "resource_type" : null,
        "resource_id" : null,
        "tag_key" : null,
        "tag_value" : null
      },
      "policy_filter_v2" : null,
      "period" : "TwentyFour_Hours",
      "state" : "Enabled",
      "created" : "2025-06-17T07:49:38.717Z",
      "updated" : "2025-06-17T07:49:38.717Z",
      "policy_definition_id" : "77982d0e4e8954e37d0f6919",
      "custom_policy" : null,
      "parameters" : {
        "trackBucket" : {
          "value" : "rms"
        }
      },
      "tags" : [ {
        "key" : "AAA",
        "value" : "AAA"
      } ],
      "created_by" : "ServiceLinkedAgencyForRMSConforms",
      "target_type" : null,
      "target_id" : null
    },
    "results" : {
      "resource_details" : {
        "compliant_count" : 0,
        "non_compliant_count" : 1
      },
      "assignment_details" : null
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.config.v1.region.ConfigRegion;
import com.huaweicloud.sdk.config.v1.*;
import com.huaweicloud.sdk.config.v1.model.*;


public class CollectPolicyStatesSummarySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ConfigClient client = ConfigClient.newBuilder()
                .withCredential(auth)
                .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                .build();
        CollectPolicyStatesSummaryRequest request = new CollectPolicyStatesSummaryRequest();
        try {
            CollectPolicyStatesSummaryResponse response = client.collectPolicyStatesSummary(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkconfig.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = ConfigClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CollectPolicyStatesSummaryRequest()
        response = client.collect_policy_states_summary(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := config.ConfigClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := config.NewConfigClient(hcClient)

    request := &model.CollectPolicyStatesSummaryRequest{}
	response, err := client.CollectPolicyStatesSummary(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Query results

400

入参数不合法。

403

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

404

资源未找到。

500

服务器内部错误。

错误码

请参见错误码

相关文档