文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 查询组织内每个成员账号合规规则部署的详细状态
更新时间:2024-07-10 GMT+08:00
分享

查询组织内每个成员账号合规规则部署的详细状态

功能介绍

查询组织内每个成员账号合规规则部署的详细状态。

调用方法

请参见如何调用API

URI

GET /v1/resource-manager/organizations/{organization_id}/policy-assignment-detailed-status

表1 路径参数

参数

是否必选

参数类型

描述

organization_id

String

组织ID。

最大长度:34

表2 Query参数

参数

是否必选

参数类型

描述

organization_policy_assignment_name

String

组织合规规则名称。

最大长度:60

organization_policy_assignment_id

String

组织合规规则ID

最大长度:32

domain_id

String

账号ID。

最大长度:36

status

String

成员账号规则部署状态,区分大小写。

最大长度:20

limit

Integer

最大的返回数量。

最小值:1

最大值:200

缺省值:200

marker

String

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

最小长度:4

最大长度:400

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

value

Array of OrganizationPolicyAssignmentDetailedStatusResponse objects

组织合规规则部署详细状态结果列表。

page_info

PageInfo object

分页对象。

表5 OrganizationPolicyAssignmentDetailedStatusResponse

参数

参数类型

描述

domain_id

String

账号ID。

policy_assignment_id

String

合规规则ID。

policy_assignment_name

String

合规规则名称。

member_account_policy_assignment_status

String

成员账号中配置规则的部署状态。

error_code

String

当创建或更新合规规则失败时错误码。

error_message

String

当创建或更新合规规则失败时错误信息。

created_at

String

创建时间。

updated_at

String

更新时间。

表6 PageInfo

参数

参数类型

描述

current_count

Integer

当前页的资源数量。

最小值:0

最大值:200

next_marker

String

下一页的marker。

最小长度:4

最大长度:400

状态码: 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

错误消息内容。

请求示例

响应示例

状态码: 200

操作成功。

{
  "value" : [ {
    "domain_id" : "3fd23817bd85480e8dc4f520075de348",
    "policy_assignment_id" : "63c79416e34d812e56d3e2fc",
    "policy_assignment_name" : "allowed-images-by-id",
    "member_account_policy_assignment_status" : "CREATE_SUCCESSFUL",
    "error_code" : "null,",
    "error_message" : "null,",
    "created_at" : "2023-01-17T09:38:26.165Z",
    "updated_at" : "2023-01-17T09:38:26.165Z"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "CAESIGQwMmI3ZmE5ZDVhNzRlNjM4YzE0MDJkMDg2OGY3MWZkGgTnpS5u"
  }
}

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
50
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 ShowOrganizationPolicyAssignmentDetailedStatusSolution {

    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();
        ShowOrganizationPolicyAssignmentDetailedStatusRequest request = new ShowOrganizationPolicyAssignmentDetailedStatusRequest();
        request.withOrganizationPolicyAssignmentName("<organization_policy_assignment_name>");
        request.withOrganizationPolicyAssignmentId("<organization_policy_assignment_id>");
        request.withStatus(ShowOrganizationPolicyAssignmentDetailedStatusRequest.StatusEnum.fromValue("<status>"));
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        try {
            ShowOrganizationPolicyAssignmentDetailedStatusResponse response = client.showOrganizationPolicyAssignmentDetailedStatus(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
35
# 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 = ShowOrganizationPolicyAssignmentDetailedStatusRequest()
        request.organization_policy_assignment_name = "<organization_policy_assignment_name>"
        request.organization_policy_assignment_id = "<organization_policy_assignment_id>"
        request.status = "<status>"
        request.limit = <limit>
        request.marker = "<marker>"
        response = client.show_organization_policy_assignment_detailed_status(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
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.ShowOrganizationPolicyAssignmentDetailedStatusRequest{}
	organizationPolicyAssignmentNameRequest:= "<organization_policy_assignment_name>"
	request.OrganizationPolicyAssignmentName = &organizationPolicyAssignmentNameRequest
	organizationPolicyAssignmentIdRequest:= "<organization_policy_assignment_id>"
	request.OrganizationPolicyAssignmentId = &organizationPolicyAssignmentIdRequest
	statusRequest:= model.GetShowOrganizationPolicyAssignmentDetailedStatusRequestStatusEnum().<STATUS>
	request.Status = &statusRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ShowOrganizationPolicyAssignmentDetailedStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

500

服务器内部错误。

错误码

请参见错误码

相关文档