List server actions¶

Overview¶

Lists history of successful actions for a specified server. Deployers set permissions for this request in the policy.json file. By default, all users can list actions.

Classification¶

List

API Operation Object¶

os-instance-actions

Synchronous / Asynchronous¶

-

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{api_endpoint}/v2/{tenant_id}/servers/{server_id}/os-instance-actions

HTTP Request Header¶

Format¶

Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: <token_id>
Content-Type: application/json

HTTP Request Body¶

Format¶

none

Request Parameter¶

Request Parameters¶
name	style	format	description	required/optional
tenant_id	URI	String	The ID for the tenant or account in a multi-tenancy cloud.	required
server_id	URI	UUID	The UUID of the server instance for which you want to list actions.	required

Response¶

HTTP Response Header¶

Format¶

HTTP/1.1 <response_code> <message>       (ex. 200 OK)

<response_code>: see “HTTP Responses” section
<message>: message based on the response code
- skip auto insert field such as “X-Compute-Request-Id” and “Content-Length”, “Date”

Response Code¶

Response Codes¶
response code	condition
200	normal end
400	badRequest
401	unauthorized
403	forbidden
404	itemNotFound
405	badMethod
413	overLimit
503	serviceUnavailable

HTTP Response Body¶

Format¶

{
    "instanceActions": [
        {
            "action": "<action>",
            "instance_uuid": "<instance_uuid>",
            "message": "<message>",
            "project_id": "<project_id>",
            "request_id": "<request_id>",
            "start_time": "<start_time>",
            "user_id": "<user_id>"
        },
        {
            "action": "<action>",
            "instance_uuid": "<instance_uuid>",
            "message": "<message>",
            "project_id": "<project_id>",
            "request_id": "<request_id>",
            "start_time": "<start_time>",
            "user_id": "<user_id>"
        }
    ]
}

Response Parameter¶

Response Parameters¶
item	format	description
action	String	action instance
instance_uuid	UUID	Unique identifier of an instance
message	String	Message of action
project_id	UUID(3)	project id
request_id	String	request id
start_time	time/date	Start time of the action
user_id	String(1-255 characters)	owner of instance

Sample API Request and Response¶

Sample API Request¶

Request URI¶

https://example.com/v2/{tenant_id}/servers/{server_id}/os-instance-actions

Request Header¶

Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: ajk3adjiown02
Content-Type: application/json

Request Body¶

none

Sample API Response¶

Response Header¶

HTTP/1.1 200 OK

<response_code>: see “HTTP Responses” section
<message>: message based on the response code
- skip auto insert field such as “X-Compute-Request-Id” and “Content-Length”, “Date”

Response Body¶

{
     "instanceActions": [
         {
             "action": "resize",
             "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
             "message": "",
             "project_id": "842",
             "request_id": "req-25517360-b757-47d3-be45-0e8d2a01b36a",
             "start_time": "2012-12-05 01:00:00.000000",
             "user_id": "789"
         },
         {
             "action": "reboot",
             "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
             "message": "",
             "project_id": "147",
             "request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
             "start_time": "2012-12-05 00:00:00.000000",
             "user_id": "789"
         }
     ]
 }

Execution Example¶

HTTP Request¶

GET /v2/ad355aa6ed3e4cf5ae0fa0df652bc291/servers/aef82e69-0b3e-4056-b1b6-c37d5a278183/os-instance-actions HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:8774
X-Auth-Token: c75def63cc764c50a96129a7069a3879
Accept: application/json

HTTP Response¶

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 316
X-Compute-Request-Id: req-d5288f5e-63a3-4d83-b094-01b3feebea10
Date: Thu, 15 Oct 2015 05:23:11 GMT

{"instanceActions": [{"instance_uuid": "aef82e69-0b3e-4056-b1b6-c37d5a278183", "user_id": "9789b276da0643e8b88bc7d6b85cf939", "start_time": "2015-10-15T00:40:25.000000", "request_id": "req-bdff6b70-dede-4292-9f8f-2e9b00adf678", "action": "create", "message": null, "project_id": "ad355aa6ed3e4cf5ae0fa0df652bc291"}]}

Error Execution Example¶

HTTP Request¶

GET /v2/ad355aa6ed3e4cf5ae0fa0df652bc290/servers/aef82e69-0b3e-4056-b1b6-c37d5a278183/os-instance-actions HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:8774
X-Auth-Token: c75def63cc764c50a96129a7069a3879
Accept: application/json

HTTP Response¶

HTTP/1.1 400 Bad Request
Content-Length: 188
Content-Type: application/json; charset=UTF-8
X-Compute-Request-Id: req-63b7d787-40b9-43c6-bac7-02b1e2535164
Date: Thu, 15 Oct 2015 05:36:20 GMT

{"badRequest": {"message": "Malformed request URL: URL's project_id 'ad355aa6ed3e4cf5ae0fa0df652bc290' doesn't match Context's project_id 'ad355aa6ed3e4cf5ae0fa0df652bc291'", "code": 400}}

Delete server metadata item

Get action details