Obtaining Operation Details
Function
This API is used to obtain the details of a specified operation. It is used when you need to know the execution status of an operation for troubleshooting or operation audit. Before using this API, ensure that you have logged in to the system and have the permission to query the details of an operation, and the specified operation exists. After the query, the API returns the details of the specified operation, including the operation ID, operation type, execution status, start time, end time, and operation result. If you do not have the operation permission, the specified operation does not exist, or the operation ID is invalid, the API returns an error message.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v1/{project_id}/dev-servers/{id}/operation/{operation_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
Definition: Lite Server instance ID. Constraints: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Range: N/A Default Value: N/A |
|
operation_id |
Yes |
String |
Definition: Operation ID. Constraints: N/A Range: N/A Default Value: N/A |
|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
operation_id |
String |
Definition: Operation ID. Range: 8 to 36 characters |
|
operation_status |
String |
Definition: Operation status. Range: 8 to 36 characters |
|
operation_type |
String |
Definition: Operation type. Range: 8 to 36 characters |
|
operation_error |
ServerOperationError object |
Definition: Error message. |
Example Requests
GET https://{endpoint}/v1/{project_id}/dev-servers/{id}/operation/{operation_id}
Example Responses
Status code: 200
Definition: Operation details.
{
"operation_id" : "UUID",
"operation_status" : "running",
"operation_type" : "node_detach_volume"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Definition: Operation details. |
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