Help Center/ Resource Governance Center/ API Reference/ APIs/ Checking Governance Maturity/ Querying the Status of the Latest Governance Check
Updated on 2026-01-13 GMT+08:00
View PDF
Share

Querying the Status of the Latest Governance Check

Function

This API is used to query the status of the latest governance maturity check.

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:bestPractice:getStatus

Read

-

-

-

-

URI

GET /v1/best-practice/status

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

operation_id

String

Operation ID.

status

String

Status: ongoing, succeeded, or failed.

percentage_complete

Integer

Check progress.

error_messages

Array of strings

Error message.

Status code: 403

Table 2 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 3 ForbiddenErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Querying the status of the latest governance maturity check

GET https://{endpoint}/v1/best-practice/status

Example Responses

Status code: 200

Request sent.

{
  "operation_id" : "string",
  "status" : "succeeded",
  "percentage_complete" : 100,
  "error_messages" : [ ]
}

Status Codes

Status Code

Description

200

Request sent.

403

No permissions.

Error Codes

See Error Codes.