# 查询规则的合规总结 - CollectPolicyAssignmentsStatesSummary #### 功能介绍 根据规则ID查询此规则的合规总结 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-rms/rms_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rms/rms_05_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rms:policyStates:get | Read | policyAssignments | g:ResourceTag/\ | - | - | #### URI GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states/summary 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 账号ID。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字及"_"、"-"组成，且长度为\[1\~36\]个字符。 **默认取值**： 不涉及 最大长度：**36** | | policy_assignment_id | 是 | String | **参数解释**： 规则ID。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字及"_"、"-"组成，且长度为\[1\~36\]个字符 **默认取值**： 不涉及 最大长度：**36** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_name | 否 | String | **参数解释**： 资源名称。 **约束限制**： 不涉及 **取值范围**： 长度为\[1\~256\]个字符 **默认取值**： 不涉及 最大长度：**256** | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | compliance_state | String | **参数解释**： 合规结果。 **取值范围**： 不涉及 | | policy_assignment | [PolicyAssignment] object | **参数解释**： 规则。 | | results | [PolicyComplianceSummaryResults] object | **参数解释**： 合规总结结果。 | 表4PolicyAssignment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_assignment_type | String | **参数解释**： 规则类型。 **取值范围**： - builtin：预定义合规规则 - custom：自定义合规规则 | | id | String | **参数解释**： 规则ID。 **取值范围**： 不涉及 | | name | String | **参数解释**： 规则名称。 **取值范围**： 不涉及 | | description | String | **参数解释**： 规则描述。 **取值范围**： 不涉及 | | policy_filter | [PolicyFilterDefinition] object | **参数解释**： 合规规则仅评估满足以下条件的资源，该字段已不推荐使用，推荐使用PolicyFilterDefinitionV2字段。 | | policy_filter_v2 | [PolicyFilterDefinitionV2] object | **参数解释**： 合规规则仅评估满足以下条件的资源，与PolicyFilterDefinition字段相比，支持更灵活的资源过滤条件。 | | 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\ | **参数解释**： 规则参数。 | | tags | Array of [ResourceTag] objects | **参数解释**： 标签列表 | | created_by | String | **参数解释**： 规则的创建者 **取值范围**： 不涉及 | | target_type | String | **参数解释**： 合规规则修正方式。 **取值范围**： - fgs：函数工作流 - rfs：资源编排服务 | | target_id | String | **参数解释**： 修正执行的目标id。 **取值范围**： 不涉及 | 表5PolicyFilterDefinition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | region_id | String | **参数解释**： 区域ID。 **取值范围**： 长度为\[1\~128\]个字符。 | | resource_provider | String | **参数解释**： 云服务名称。 **取值范围**： 长度为\[1\~128\]个字符。 | | resource_type | String | **参数解释**： 资源类型。 **取值范围**： 长度为\[1\~128\]个字符。 | | resource_id | String | **参数解释**： 资源ID。 **取值范围**： 长度为\[1\~512\]个字符。 | | tag_key | String | **参数解释**： 标签键。 **取值范围**： 长度为\[1\~128\]个字符。 | | tag_value | String | **参数解释**： 标签值。 **取值范围**： 长度为\[1\~256\]个字符。 | 表6PolicyFilterDefinitionV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：或 | | 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：或 | | exclude_tags | Array of [FilterTagDetail] objects | **参数解释**： 排除标签列表，排除标签列表比生效标签列表有更高的优先级 | 表7FilterTagDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签key **取值范围**： 不涉及 | | values | Array of strings | **参数解释**： 标签值列表 | 表8CustomPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | function_urn | String | **参数解释**： 自定义函数的URN，可以在FunctionGraph服务函数列表获取 **取值范围**： 长度为\[1\~1024\]个字符 | | auth_type | String | **参数解释**： 自定义合规规则调用function方式。 **取值范围**： - agency：自定义委托 - serviceLinkedAgency：服务关联委托 | | auth_value | Map\ | **参数解释**： 自定义合规规则调用function方式的参数值 | 表9PolicyParameterValue | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | Object | **参数解释**： 规则参数值。 | 表10ResourceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **取值范围**： 长度为\[1-128\]个unicode字符。 | | value | String | **参数解释**： 标签值。 **取值范围**： 长度为\[0-255\]个unicode字符。 | 表11PolicyComplianceSummaryResults | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_details | [ResourceComplianceSummaryUnit] object | **参数解释**： 当前账号下合规与不合规的资源数量 | | assignment_details | [PolicyComplianceSummaryUnit] object | **参数解释**： 当前账号下合规与不合规的规则数量 | 表12ResourceComplianceSummaryUnit | 参数 | 参数类型 | 描述 | |:---|:---|:---| | compliant_count | Integer | **参数解释**： 合规的资源数量。 **取值范围**： 不涉及 | | non_compliant_count | Integer | **参数解释**： 不合规的资源数量。 **取值范围**： 不涉及 | 表13PolicyComplianceSummaryUnit | 参数 | 参数类型 | 描述 | |:---|:---|:---| | compliant_count | Integer | **参数解释**： 合规的规则数量。 **取值范围**： 不涉及 | | non_compliant_count | Integer | **参数解释**： 不合规的规则数量。 **取值范围**： 不涉及 | **状态码：400** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：403** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：404** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：500** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 操作成功。 ``` { "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代码示例如下。 #### Java ``` 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 CollectPolicyAssignmentsStatesSummarySolution { 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("")) .build(); CollectPolicyAssignmentsStatesSummaryRequest request = new CollectPolicyAssignmentsStatesSummaryRequest(); request.withPolicyAssignmentId("{policy_assignment_id}"); try { CollectPolicyAssignmentsStatesSummaryResponse response = client.collectPolicyAssignmentsStatesSummary(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()); } } } ``` #### Python ``` # 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("")) \ .build() try: request = CollectPolicyAssignmentsStatesSummaryRequest() request.policy_assignment_id = "{policy_assignment_id}" response = client.collect_policy_assignments_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) ``` #### Go ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := config.NewConfigClient(hcClient) request := &model.CollectPolicyAssignmentsStatesSummaryRequest{} request.PolicyAssignmentId = "{policy_assignment_id}" response, err := client.CollectPolicyAssignmentsStatesSummary(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Config/sdk?api=CollectPolicyAssignmentsStatesSummary)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 输入参数不合法。 | | 403 | 用户认证失败或没有操作权限。 | | 404 | 资源未找到。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rms/ErrorCode.html)。