Querying the Operating Status of a Governance Policy

Updated on 2025-02-20 GMT+08:00

View PDF

Function

This API is used to query the operating status by operation ID.

URI

GET https://{endpoint}/v1/governance/operation-control-status/{operation_control_status_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
operation_control_status_id	Yes	String	Request ID for performing operations on a governance policy.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
control_operation	ControlOperation object	Implementation of a governance policy.

**Table 3** ControlOperation
Parameter	Type	Description
operation_control_status_id	String	ID of an entity performing operations on a governance policy.
operation_type	String	Type of operations on a governance policy. It can be enabling or disabling operations.
status	String	Implementation status of a governance policy. It can be SUCCEEDED, FAILED, or IN_PROGRESS.
message	String	Error messages about the failure to implement a governance policy.
start_time	String	Time when an operation is started.
end_time	String	Time when an operation is ended.

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 operating status by operation ID

GET https://{endpoint}/v1/governance/operation-control-status/{operation_control_status_id}

Example Responses

Status code: 200

Request succeeded.

{
  "control_operation" : {
    "operation_control_status_id" : "string",
    "operation_type" : "string",
    "status" : "string",
    "message" : "string",
    "start_time" : "string",
    "end_time" : "string"
  }
}