- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
- Managing the Landing Zone
-
Managing Organizations
- Registering an OU
- Re-registering an OU
- Deregistering an OU
- Querying Operations on Registered OUs and Enrolled Accounts
- Querying Registration Information
- Deleting a Registered OU
- Querying Registered OUs
- Creating an OU
- Listing Registered OUs Enabled with Governance Policies
- Enrolling an Account
- Unmanaging an Account
- Updating an Enrolled Account
- Querying an Enrolled Account
- Querying the Template Information of an Enrolled Account
- Listing Enrolled Accounts in a Registered OU
- Creating an Account
- Listing Enrolled Accounts for Governance Policies
- Listing Enrolled Core Accounts
-
Governing the Landing Zone
- Listing Governance Policies
- Listing Non-Compliant Resources
- Querying a Governance Policy
- Enabling a Governance Policy
- Disabling a Governance Policy
- Querying the Operating Status of a Governance Policy
- Listing Enabled Governance Policies
- Listing Governance Policies Enabled for a Registered OU
- Listing Governance Policies Enabled for an Enrolled Account
- Querying the Compliance of an Enrolled Account
- Querying the Compliance Status of a Registered OU
- Querying a Governance Policy Enabled for a Registered OU
- Querying Governance Policies Enabled for an Enrolled Account
- Querying the Compliance of Config Rules
- Querying the Compliance of External Config Rules for Enrolled Accounts
- Listing Drifts
- Managing Templates
- Checking Governance Maturity
- Permissions and Supported Actions
- Appendix
- FAQs
- General Reference
Copied.
Querying the Operating Status of a Governance Policy
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}
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
Parameter |
Type |
Description |
---|---|---|
control_operation |
ControlOperation object |
Implementation of a governance policy. |
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
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. |
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"
}
}
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
403 |
No permissions. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot