Help Center/ Config/ API Reference/ APIs/ Compliance/ Querying Details About the Rule Statuses of Each Member Account in an Organization
Updated on 2024-07-10 GMT+08:00

Querying Details About the Rule Statuses of Each Member Account in an Organization

Function

This API is used to querying details about the rule statuses of each member account in an organization.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

organization_id

Yes

String

Specifies the organization ID.

Maximum: 34

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

organization_policy_assignment_name

No

String

Specifies the organization rule name.

Maximum: 60

organization_policy_assignment_id

No

String

Specifies the organization assignment id

Maximum: 32

domain_id

No

String

Specifies the account ID.

Maximum: 36

status

No

String

Specifies the rule status of the member account. The value is case sensitive.

Maximum: 20

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 200

Default: 200

marker

No

String

Specifies the pagination parameter.

Minimum: 4

Maximum: 400

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

value

Array of OrganizationPolicyAssignmentDetailedStatusResponse objects

Specifies the status details about organization rules.

page_info

PageInfo object

Specifies the pagination object.

Table 5 OrganizationPolicyAssignmentDetailedStatusResponse

Parameter

Type

Description

domain_id

String

Specifies the account ID.

policy_assignment_id

String

Specifies the rule ID.

policy_assignment_name

String

Specifies the rule name.

member_account_policy_assignment_status

String

Specifies the status of the rule in a member account in an organization.

error_code

String

Specifies the error code returned when a rule fails to be created or updated.

error_message

String

Specifies the error message returned when a rule fails to be created or updated.

created_at

String

Specifies the creation time.

updated_at

String

Specifies the update time.

Table 6 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

Authentication failed or you do not have the operation permissions.

500

Server error.

Error Codes

See Error Codes.