List Operation¶

Summary¶

List all visible Operations.

Type¶

List

Synchronous/Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{api_endpoint}/v1.0/operations

HTTP Request Header¶

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

注釈

Field names in HTTP request header are case-insensitive.

HTTP Request Body¶

Parameters¶

Input Parameters¶
name	style	datatype	format	description	required/optional	default value	action for invalid parameter	response code for invalid parameter
token_id	Header	String	Non-Hyph-uuid	keystone authentication token	required		Terminate	401
id	Query	String	Hyph-uuid	ID of the operation	optional
resource_id	Query	String	Hyph-uuid	ID of the resource	optional
resource_type	Query	String	String(0-255)	Type of the resource	optional
request_id	Query	String	Hyph-uuid	A request_id to identify requests.	optional
request_type	Query	String	String(0-255)	Type of request	optional
status	Query	String	String(0-255)	Status of phase	optional
tenant_id	Query	String	Non-Hyph-uuid	Tenant ID of the owner (UUID)	optional
no_deleted	Query	Boolean		If no_deleted is true, operation of deleted VNA is not displayed.	optional	false
latest	Query	Boolean		If latest is true, only the most recent operation of each VNA is displayed.	optional	false

Response¶

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

Response Code¶

Response Codes¶
response code	condition
200	OK
401	Unauthorized
500	Internal Server Error

Response Body¶

Format¶

{
  "operations": [
    {
      "id": "<id>",
      "resource_id": "<resource_id>",
      "resource_type": "<resource_type>",
      "request_id": "<request_id>",
      "request_type": "<request_type>",
      "request_body": "<request_body>",
      "status": "<status>",
      "reception_datetime": "<reception_datetime>",
      "commit_datetime": "<commit_datetime>",
      "warning" : "<warning>",
      "error": "<error>",
      "tenant_id": "<tenant_id>"
    }
  ]
}

Parameters¶

Response Parameters¶
item	datatype	format	description
operations	Array<Object>	-
id	String	Hyph-uuid	It identifies a operation uniquely.
resource_id	String	Hyph-uuid	It identifies a resource uniquely.
resource_type	String	String(0-255)	Type of resource
request_id	String	Hyph-uuid	A request_id to identify requests.
request_type	String	String(0-255)	Type of request
request_body	Object	-	Stored the request body when executing API.
status	String	String(0-255)	Status of phase
reception_datetime	String	Date	Reception datetime of the executed API. Time zone is represented as UTC.
commit_datetime	String	Date	Commit datetime of the executed API. Time zone is represented as UTC.
warning	String	Mediumtext	The warning message of operation that has been stopped or failed.
error	String	Mediumtext	The error message of operation that has been stopped or failed.
tenant_id	String	Non-Hyph-uuid	Tenant ID of the owner (UUID)

Sample Request and Response¶

Sample API Request¶

Request URI¶

https://{api_endpoint}/v1.0/operations

Request Header¶

Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4

Request Body¶

This operation does not send a request body.

Sample API Response¶

Response Header¶

HTTP/1.1 200 OK

Response Body¶

{
  "operations": [
    {
      "id": "75aab8db-8632-42b4-af2f-06b5820798ef",
      "resource_id": "a80c1728-cc0c-11e6-8080-525400060300",
      "resource_type": "ECL::VirtualNetworkAppliance::VSRX",
      "request_id": "",
      "request_type": "Create",
      "request_body": {
        "virtual_network_appliance": {
          "name": "virtual_network_appliance_name",
          "description": "virtual_network_appliance_name_description",
          "default_gateway": "192.168.0.1",
          "availability_zone": "zone1-groupa",
          "virtual_network_appliance_plan_id": "b0cdb8c5-aaf0-48eb-81ac-f211b54da53c",
          "tenant_id": "13572f6f42a74d2b82f7099f78d0393a",
          "tags": {},
          "interfaces": {
            {
              "interface_1": {
                "name": "interface_name",
                "network_id": "0967afc2-73a8-4c1f-869a-54c3b07dc199",
                "tags": {},
                "fixed_ips": [
                  {
                    "ip_address": "192.168.0.100"
                  }
                ]
              }
            }
          }
        }
      },
      "status": "Complete",
      "reception_datetime": "2017-11-27 21:35:38",
      "commit_datetime": "2017-11-27 21:46:21",
      "warning" : null,
      "error": null,
      "tenant_id": "13572f6f42a74d2b82f7099f78d0393a"
    }
  ]
}

Example Error Message¶

HTTP Request¶

GET /v1.0/operations HTTP/1.1
User-Agent: curl/7.51.0
Host: 10.1.131.140
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Type: application/json

HTTP Response¶

HTTP/1.1 500 Internal Server Error
Server: nginx
Date: Wed, 07 Feb 2018 06:49:20 GMT
Content-Type: application/json
Content-Length: 40
Connection: keep-alive

{
  "cause": "Internal Server Error"
}

Show Virtual Network Appliance Plan

Show Operation