• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Status Management
  6. Querying ECS Actions by Request ID

Querying ECS Actions by Request ID

Function

This API is used to query a request of an ECS.

URI

GET /v2.1/{project_id}/servers/{server_id}/os-instance-actions/{request_id}

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

server_id

Yes

Specifies the ECS ID.

request_id

Yes

Specifies the request ID.

Request

N/A

Response

Response parameters

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Mandatory

Description

action

String

Yes

Specifies the action name.

instance_uuid

String

Yes

Specifies the ECS ID in UUID format.

message

String

Yes

Specifies the result status of the action.

project_id

String

Yes

Specifies the project ID.

request_id

String

Yes

Specifies the request ID.

start_time

String

Yes

Specifies the time when the action was started.

user_id

String

Yes

Specifies the user ID.

events

List(Dict)

Yes

Specifies event information.

Table 3 events parameters

Parameter

Type

Mandatory

Description

event

String

Yes

Specifies the action name.

result

String

Yes

Specifies the execution result.

traceback

String

Yes

Specifies the error message.

start_time

String

Yes

Specifies the time when the event was started.

finish_time

String

Yes

Specifies the time when the event was completed.

Examples

  • Example request
    GET /v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c
    GET /v2.1/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c
  • Example response
    {
        "instanceAction": {
            "instance_uuid": "e723eb40-f56e-40f9-8c8c-caa517fe06ba",
            "user_id": "752be40780484291a9cc7ae50fff3e6d",
            "start_time": "2014-12-11T02:17:49.000000",
            "request_id": "req-5a429946-c9cc-45cc-b5bd-68864209e5cc",
            "action": "create",
            "message": null,
            "project_id": "89655fe61c4c4a08b9f3e7f9095441b8",
            "events": [
                {
                    "finish_time": "2014-12-11T02:17:58.000000",
                    "start_time": "2014-12-11T02:17:50.000000",
                    "traceback": null,
                    "event": "compute_build_and_run_instance",
                    "result": "Success"
                }
            ]
        }
    }

Returned Values

See General Request Returned Values.