文档首页/ 配置审计 Config/ API参考/ API/ 资源聚合器/ 查询聚合器中一个或多个账号的合规概况
更新时间:2024-06-13 GMT+08:00
分享

查询聚合器中一个或多个账号的合规概况

功能介绍

查询聚合器中一个或多个账号的合规和不合规规则数。

调用方法

请参见如何调用API

URI

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

表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

group_by_key

String

用于对资源计数进行分组的键(DOMAIN)。

最小长度:1

最大长度:16

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

results

Array of AggregatePolicyComplianceSummaryResult objects

合规总结结果列表

表5 AggregatePolicyComplianceSummaryResult

参数

参数类型

描述

resource_details

PolicyComplianceSummaryUnit object

规则总结详情。

assignment_details

PolicyComplianceSummaryUnit object

规则总结详情。

group_name

String

分组名称

group_account_name

String

账号名称

表6 PolicyComplianceSummaryUnit

参数

参数类型

描述

compliant_count

Integer

合规数量。

non_compliant_count

Integer

不合规数量。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

查询聚合器中一个或多个账号的合规概况

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

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "group_by_key" : "DOMAIN"
}

响应示例

状态码: 200

操作成功。

{
  "results" : [ {
    "resource_details" : {
      "compliant_count" : null,
      "non_compliant_count" : 70
    },
    "assignment_details" : {
      "compliant_count" : 0,
      "non_compliant_count" : 1
    },
    "group_name" : "39f4a9434e0c4bf3806e5aff54adea39",
    "group_account_name" : "demo1"
  }, {
    "resource_details" : {
      "compliant_count" : null,
      "non_compliant_count" : 0
    },
    "assignment_details" : {
      "compliant_count" : 1,
      "non_compliant_count" : 0
    },
    "group_name" : "789d4ac10eda4d9b8e090f5c2b1e4459",
    "group_account_name" : "demo2"
  } ]
}

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
46
47
48
49
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 ShowAggregatePolicyStateComplianceSummarySolution {

    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();
        ShowAggregatePolicyStateComplianceSummaryRequest request = new ShowAggregatePolicyStateComplianceSummaryRequest();
        AggregatePolicyStatesRequest body = new AggregatePolicyStatesRequest();
        body.withGroupByKey("DOMAIN");
        body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f");
        request.withBody(body);
        try {
            ShowAggregatePolicyStateComplianceSummaryResponse response = client.showAggregatePolicyStateComplianceSummary(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
31
32
33
34
# 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 = ShowAggregatePolicyStateComplianceSummaryRequest()
        request.body = AggregatePolicyStatesRequest(
            group_by_key="DOMAIN",
            aggregator_id="7ca3447830bd49c9b630a99680eaf90f"
        )
        response = client.show_aggregate_policy_state_compliance_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
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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := config.NewConfigClient(
        config.ConfigClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowAggregatePolicyStateComplianceSummaryRequest{}
	groupByKeyAggregatePolicyStatesRequest:= "DOMAIN"
	request.Body = &model.AggregatePolicyStatesRequest{
		GroupByKey: &groupByKeyAggregatePolicyStatesRequest,
		AggregatorId: "7ca3447830bd49c9b630a99680eaf90f",
	}
	response, err := client.ShowAggregatePolicyStateComplianceSummary(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

500

服务器内部错误。

错误码

请参见错误码

相关文档