List exchange_point¶
Summary¶
This API returns pair of endpoint for Cloud service provider(e.g., AWS) and NTTCom.
Type¶
- List
Target object of API¶
- exchange_point
Synchronous/Asynchronous¶
- synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v2.0/exchange_points
HTTP Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>
HTTP Request Body¶
Parameters¶
name | style | format | description | required/optional | default value | action for invalid parameter | response code for invalid parameter |
---|---|---|---|---|---|---|---|
token_id | Header | authentication token string(varchar) | keystone authentication token | required | Terminate | 401 | |
service_type | Query | String(ECL::SDExchange::AWSConnection, ECL::SDExchange::GCPConnection) | service type. | 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 Body¶
Format¶
{
"exchange_points":[
{
"id": "<id>",
"location_names": ["<location_name>", "<location_name>"],
"service_type": "<service_type>"
}
]
}
Parameters¶
item | format | description |
exchange_points | Array | |
id | String(UUID) | It identifies exchange_point resource uniquely. |
location_names | Array | Pair of endpoint. The former is endpoint's name for Cloud service provider(e.g., AWS), the latter for NTTCom. |
service_type | String(ECL::SDExchange::AWSConnection, ECL::SDExchange::GCPConnection) | service type |
Sample Request and Response¶
Sample API request¶
Request URI¶
https://{api_endpoint}/v2.0/exchange_points
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¶
{
"exchange_points":[
{
"id": "ef402770-c012-11e6-9751-525400060400",
"location_names": ["ap-northeast-1","zone1"],
"service_type": "ECL::SDExchange::AWSConnection"
}
]
}
Example error message¶
HTTP request¶
GET /v2.0/exchange_points 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"
}