List aws_connection

Summary

List aws_connection resource.

Type

  • Get

Target object of API

  • aws_connection

Synchronous/Asynchronous

  • synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2.0/aws_connections

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 default value action for invalid parameter response code for invalid parameter
token_id Header authentication token string(32) keystone authentication token required   Terminate 401
id Query String(UUID) It identifies aws_connection resource uniquely. optional      
name Query String(0-255) Name of aws_connection. optional      
description Query String(0-255) Description of aws_connection. optional      
status Query String(active,down) Status of aws_connection. optional      
tenant_id Query String(UUID) Tenant ID of the owner. optional      
bandwidth Query String(50,100,200,300,400,500,1000) Bandwidth assigned with this aws_connection. optional      
qos_type Query String(BestEffort, Guarantee) QoS type assigned with this aws_connection optional      
exchange_point_id Query String(UUID) ID of exchange_points. optional      

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

{
  "aws_connections": [
    {
      "id": "<id>",
      "name": "<name>",
      "description": "<description>",
      "status": "<status>",
      "tenant_id": "<tenant_id>",
      "bandwidth": "<bandwidth>",
      "qos_type": "<qos_type>",
      "exchange_point_id": "<exchange_point_id>",
      "aws_network1": {
        "aws_gateway_id": "<aws_gateway_id>",
        "aws_interface_id": "<aws_interface_id>",
        "primary_connected_segment": {
          "network_address": "<network_address>",
          "intermediate_router_ip": "<intermediate_router_ip>",
          "aws_interface_ip": "<aws_interface_ip>"
        },
        "secondary_connected_segment": {
          "network_address": "<network_address>",
          "intermediate_router_ip": "<intermediate_router_ip>",
          "aws_interface_ip": "<aws_interface_ip>"
        }
      },
      "aws_network2": {
        "aws_account_id": "<aws_account_id>",
        "primary_virtual_interface_id": "<primary_virtual_interface_id>",
        "secondary_virtual_interface_id": "<secondary_virtual_interface_id>",
        "primary_virtual_interface_name": "<primary_virtual_interface_name>",
        "secondary_virtual_interface_name": "<secondary_virtual_interface_name>",
        "primary_connected_segment": {
          "network_address": "<network_address>",
          "intermediate_router_ip": "<intermediate_router_ip>",
          "amazon_ip": "<amazon_ip>"
        },
        "secondary_connected_segment": {
          "network_address": "<network_address>",
          "intermediate_router_ip": "<intermediate_router_ip>",
          "amazon_ip": "<amazon_ip>"
        }
      }
    }
  ]
}

Parameters

Response Parameters
item format description
aws_connections Array  
id String(UUID) It identifies aws_connection resource uniquely.
name String(0-255) Name of aws_connection.
description String(0-255) Description of aws_connection.
status String(active, down) Status of aws_connection.
tenant_id String(32) Tenant ID of the owner.
bandwidth String(50,100,200,300,400,500,1000) Bandwidth assigned with this aws_connection.
qos_type String(BestEffort, Guarantee) QoS type assigned with this aws_connection
exchange_point_id String(UUID) ID of exchange_points.
aws_network1 Object Network information of NTTCom side. Displayed if the detail option is set to true.
aws_gateway_id String(UUID) aws_gateway resource which this aws_connection is attached to.
aws_interface_id String(UUID) aws_interface resource which this aws_connection is attached to.
primary_connected_segment Object Primary network configuration.
network_address String Primary network segment.
intermediate_router_ip String IP address of intermediate router in NTTcom.
aws_interface_ip String IP address of aws_interface resource.
secondary_connected_segment Object Secondary network configuration.
network_address String Secondary network segment.
intermediate_router_ip String IP address of intermediate router in NTTcom.
aws_interface_ip String IP address of aws_interface resource.
aws_network2 Object Network information of AWS side. Displayed if the detail option is set to true.
aws_account_id String(12) AWS Account ID of owner.
primary_virtual_interface_id String Virtual interface ID generated by AWS direct connect.
secondary_virtual_interface_id String Virtual interface ID generated by AWS direct connect.
primary_virtual_interface_name String Virtual interface name for AWS direct connect.
secondary_virtual_interface_name String Virtual interface name for AWS direct connect.
primary_connected_segment Object Primary network configuration.
network_address String Primary network segment.
intermediate_router_ip String IP address of intermediate router in NTTcom.
amazon_ip String IP address of amazon side.
secondary_connected_segment Object Secondary network configuration.
network_address String Secondary network segment.
intermediate_router_ip String IP address of intermediate router in NTTcom.
amazon_ip String IP address of amazon side.

Sample Request and Response

Sample API request

Request URI

https://{api_endpoint}/v2.0/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

{
  "aws_connections":[
    {
      "id": "a80c1728-cc0c-11e6-8080-525400060300",
      "name": "aws_connection_name",
      "description": "hoge",
      "status": "active",
      "tenant_id": "13572f6f42a74d2b82f7099f78d0393a",
      "bandwidth": "100",
      "qos_type": "BestEffort",
      "exchange_point_id":"ef402770-c012-11e6-9751-525400060400",
      "aws_network1": {
        "aws_gateway_id": "86fb5e3e-fc3f-4d37-80b0-5de91bb4e80e",
        "aws_interface_id": "93ea5c88-57d4-466e-9d23-4503b7df8497",
        "primary_connected_segment": {
          "network_address": "10.200.1.8/30",
          "intermediate_router_ip": "10.200.1.9",
          "aws_interface_ip": "10.200.1.10"
        },
        "secondary_connected_segment":{
          "network_address": "10.200.1.0/30",
          "intermediate_router_ip": "10.200.1.1",
          "aws_interface_ip": "10.200.1.2"
        }
      },
      "aws_network2": {
        "aws_account_id": "000000000000",
        "primary_virtual_interface_id": "dxvif-8x8vas3r",
        "secondary_virtual_interface_id": "dxvif-n01a3z4f",
        "primary_virtual_interface_name": "N000000904_act",
        "secondary_virtual_interface_name": "N000000904_sby",
        "primary_connected_segment": {
          "network_address": "10.200.1.0/30",
          "intermediate_router_ip": "10.200.1.1",
          "amazon_ip": "10.200.1.2"
        },
        "secondary_connected_segment":{
          "network_address": "10.200.1.4/30",
          "intermediate_router_ip": "10.200.1.5",
          "amazon_ip": "10.200.1.6"
        }
      }
    }
  ]
}

Example error message

HTTP request

GET /v2.0/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"
}