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

获取用户的合规结果 - ListPolicyStatesByDomainId

功能介绍

查询用户所有的合规结果。

调用方法

请参见如何调用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

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

账号ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

compliance_state

String

参数解释

合规结果。

约束限制

不涉及

取值范围

长度为[1~16]个字符

默认取值

不涉及

最大长度:16

resource_id

String

参数解释

资源ID。

约束限制

不涉及

取值范围

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

默认取值

不涉及

最大长度:512

resource_name

String

参数解释

资源名称。

约束限制

不涉及

取值范围

长度为[1~256]个字符

默认取值

不涉及

最大长度:256

limit

Integer

参数解释

最大的返回数量。

约束限制

不涉及

取值范围

1~200

默认取值

200

最小值:1

最大值:200

缺省值:200

marker

String

参数解释

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

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”、“=”、“+”、“/”组成,且长度为[4~400]个字符。

默认取值

不涉及

最小长度:4

最大长度:400

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

调用者token。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

X-Security-Token

String

参数解释

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

value

Array of PolicyState objects

参数解释

合规结果查询返回值。

page_info

PageInfo object

参数解释

分页对象。

约束限制

不涉及

表5 PolicyState

参数

参数类型

描述

domain_id

String

参数解释

账号ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

region_id

String

参数解释

资源区域ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

resource_id

String

参数解释

资源ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

resource_name

String

参数解释

资源名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

resource_provider

String

参数解释

云服务名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

resource_type

String

参数解释

资源类型。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

trigger_type

String

参数解释

触发器类型。

约束限制

不涉及

取值范围

  • resource:配置变更

  • period:周期执行

默认取值

不涉及

compliance_state

String

参数解释

合规结果。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

policy_assignment_id

String

参数解释

规则ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

policy_assignment_name

String

参数解释

规则名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

policy_definition_id

String

参数解释

策略ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

evaluation_time

String

参数解释

合规状态评估时间。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表6 PageInfo

参数

参数类型

描述

current_count

Integer

参数解释

当前页的资源数量。

约束限制

不涉及

取值范围

0-200

默认取值

不涉及

最小值:0

最大值:200

next_marker

String

参数解释

下一页的marker。

约束限制

不涉及

取值范围

长度为[4~400]个字符

默认取值

不涉及

最小长度:4

最大长度:400

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

请求示例

响应示例

状态码:200

操作成功。

{
  "value" : [ {
    "domain_id" : "059b5c937100d3e40ff0c00a7675a0a0",
    "region_id" : "regionid1",
    "resource_id" : "010d95bd-87cd-4f22-ac00-db7fba7d927e",
    "resource_name" : "ecs-cc-image-test1",
    "resource_provider" : "ecs",
    "resource_type" : "cloudservers",
    "trigger_type" : "resource",
    "compliance_state" : "NonCompliant",
    "policy_assignment_id" : "5fb618a726a24c53767fa049",
    "policy_assignment_name" : "policy-assignment-test1",
    "policy_definition_id" : "5fa265c0aa1e6afc05a0ff07",
    "evaluation_time" : 1605776482523
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : 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 ListPolicyStatesByDomainIdSolution {

    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();
        ListPolicyStatesByDomainIdRequest request = new ListPolicyStatesByDomainIdRequest();
        try {
            ListPolicyStatesByDomainIdResponse response = client.listPolicyStatesByDomainId(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 = ListPolicyStatesByDomainIdRequest()
        response = client.list_policy_states_by_domain_id(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.ListPolicyStatesByDomainIdRequest{}
	response, err := client.ListPolicyStatesByDomainId(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

404

资源未找到。

500

服务器内部错误。

错误码

请参见错误码

相关文档