Warning

API version 1.0 is deprecated and eventually unsupported. Please use API version 2.0.

List operation¶

Summary¶

List operation history when executing the connection API .

Type¶

Get

Target object of API¶

operation

Synchronous/Asynchronous¶

synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{api_endpoint}/v1.0/icc/operations

HTTP Request Header¶

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

HTTP Request Body¶

Parameters¶

Input Parameters¶
name	style	format	description	required/optional	action for invalid parameter	response code for invalid parameter
token_id	Header	authentication token string(32)	keystone authentication token	required	Terminate	401
connection_id	Query	string(UUID)	ID of connection resource.	optional	Terminate
order_type	Query	String(Create, Update, Delete)	order type.	optional	Terminate
phase	Query	String(prepare_connection,approve_connection,disapprove_connection,update_connection,delete_connection)	operation phase.	optional	Terminate
operation_status	Query	String(processing,complete,error)	Status of phase.	optional	Terminate
latest	Query	string(true)	If use this query, the latest operation is returned.	optional	Terminate

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":[
    {
      "connection_id": <connection_id>,
      "order_type": <order_type>,
      "phase": <phase>,
      "operation_status": <operation_status>,
      "reception_datetime": <reception_datetime>,
      "commit_datetime": <commit_datetime>,
      "request_body": {<request_body>}
    }
  ]
}

Parameters¶

Response Parameters¶
item	format	description
operations	Array
connection_id	String(UUID)	It identifies connection resource uniquely.
order_type	String(Create, Update, Delete)	order type.
phase	String(prepare_connection,approve_connection,disapprove_connection,update_connection,delete_connection)	operation phase.
operation_status	String(processing,complete,error)	Status of phase.
reception_datetime	Datetime	YYYY-MM-DD HH:MM:SS
commit_datetime	Datetime	YYYY-MM-DD HH:MM:SS
request_body	Object	Stored the request body when executing connection API.

Sample Request and Response¶

Sample API request¶

Request URI¶

http://{api_endpoint}/v1.0/icc/aws/connections

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": [
      {
          "commit_datetime": "2016-12-27 08:39:55",
          "connection_id": "a80c1728-cc0c-11e6-8080-525400060300",
          "operation_status": "complete",
          "order_type": "Create",
          "phase": "approve_connection",
          "reception_datetime": "2016-12-27 08:15:41",
          "request_body": {
              "connection": {
                  "aws_account_id": "000000000000",
                  "bandwidth": "100",
                  "connected_network_address": "10.200.1.0",
                  "description": "hoge",
                  "exchange_point_id": "ef402770-c012-11e6-9751-525400060400",
                  "name": "hoge",
                  "qos_type": "Guarantee",
                  "tenant_id": "39852f6f42a74d2b82f7099f78d0393a"
              }
          }
      }
  ]
}

Example error message¶

HTTP request¶

GET /v1.0/icc/aws/connections HTTP/1.1
User-Agent: curl/7.37.1
Host: 10.1.131.140
Content_type:application/json
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Length: 73
Content-Type: application/x-www-form-urlencoded

HTTP Response¶

HTTP/1.1 500 Internal Server Error
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 10:32:56 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 40
Connection: keep-alive

{
  "cause": "Internal Server Error"
}

List exchange_point

2. Enterprise Cloud 2.0 Provider Connectivity DataType List