Show network

Summary

Show network resource used by tenant_connection_request.

Type

  • Show

Target object of API

  • network

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2.0/tenant_connection_requests/{tenant_connection_request_id}/network

HTTP Request Header

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

HTTP Request Body

Format

No items.

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(varchar)

keystone authentication token

required

Terminate

401

tenant_connection_request_id

URL

String(UUID)

tenant_connection_request unique ID.

required

Terminate

404

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

404

Not found

500

Internal server error

Response Body

Format

{
   "network": {
     "admin_state_up": "<admin_state_up>",
     "description": "<description>",
     "id": "<id>",
     "name": "<name>",
     "plane": "<plane>",
     "shared": <shared>,
     "status": "<status>",
     "subnets": [],
     "tags": {},
     "tenant_id": "<tenant_id>"
   }
}

Parameters

Response Parameters

item

format

description

network

Object

admin_state_up

Boolean

The administrative state of the network

description

String()

Network description.

id

String(UUID)

Network unique id.

name

String()

Network name.

plane

String(data, storage)

Type of the traffic for which network will be used.

shared

Boolean

Indicates whether this network is shared across all tenants (not supported)

status

String()

The network status.

subnets

Array(UUID)

The associated subnets.

tags

Object

Network tags.

tenant_id

String(UUID)

The name of the network owner.

Sample Request and Response

Sample API request

Request URI

https://{api_endpoint}/v2.0/tenant_connection_requests/{tenant_connection_request_id}/network

Request Header

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

Request Body

No items.

Sample API response

Response Header

HTTP/1.1 200 OK

Response Body

 {
   "network": {
     "admin_state_up": true,
     "description": "",
     "id": "c06946e2-c6e9-4ff0-881f-bb32751e1685",
     "name": "tc-ln-tenant-a1",
     "plane": "data",
     "shared": false,
     "status": "ACTIVE",
     "subnets": [
       "a2df4e0c-23f4-4c7f-92bc-6f4b9ef6ec67"
     ],
     "tags": {},
     "tenant_id": "c7f3a68a73e845d4ba6a42fb80fce03f"
   }
}

Example error message

HTTP request

GET /v2.0/tenant_connection_requests/{tenant_connection_request_id}/network 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 400 Bad Request
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 10:32:56 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 39
Connection: keep-alive

{
    "cause": "Invalid request body"
}