Help Center/ Resource Governance Center/ API Reference/ APIs/ Governing the Landing Zone/ Querying the Compliance Status of a Registered OU
Updated on 2026-01-13 GMT+08:00
View PDF
Share

Querying the Compliance Status of a Registered OU

Function

This API is used to query the compliance status of resources in all enrolled accounts in a registered OU in an organization.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rgc:complianceStatusForOrganizationalUnit:get

Read

-

-

-

-

URI

GET /v1/governance/managed-organizational-units/{managed_organizational_unit_id}/compliance-status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

managed_organizational_unit_id

Yes

String

ID of a registered OU.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

control_id

No

String

ID of a governance policy.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

compliance_status

String

Compliance status.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of the request.

encoded_authorization_message

String

Encrypted error message.

details

Array of ForbiddenErrorDetail objects

Error message indicating no permissions for cross-service invoking.
Table 5 ForbiddenErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Querying the compliance status of resources in all enrolled accounts in a registered OU in an organization

GET https://{endpoint}/v1/governance/managed-organizational-units/{managed_organizational_unit_id}/compliance-status

Example Responses

Status code: 200

Request succeeded.

{
  "compliance_status" : "string"
}

Status Codes

Status Code

Description

200

Request succeeded.

403

No permissions.

Error Codes

See Error Codes.