List address_assignment

Summary

List IP address and mac address used by network.

Type

  • List

Target object of API

  • address_assignment

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

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

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(32) keystone authentication token required   Terminate 401
tenant_connection_request_id URL String(UUID) tenant_connection_request unique ID. required   Terminate 404
tenant_connection_request_id Query String(UUID) tenant_connection_request unique ID. optional   Terminate 404
tenant_connection_id Query String(UUID) tenant_connection unique ID. optional   Terminate 400
mac_address Query String() mac address assigned with port. optional   Terminate 400

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

{
  "address_assignments": [
    {
      "tenant_connection_request_id": "<tenant_connection_request_id>",
      "tenant_connection_id": "<tenant_connection_id>",
      "mac_address": "<mac_address>",
      "network_id": "<network_id>",
      "fixed_ips": [
        {
          "ip_address": "<ip_address>",
          "subnet_id": "<subnet_id>"
        }
      ],
      "allowed_address_pairs": [
        {
          "ip_address": "<ip_address>",
          "mac_address": "<mac_address>"
        }
      ]
    }
  ]
}

Parameters

Response Parameters
item format description
address_assignments Array  
tenant_connection_request_id String(UUID) tenant_connection_request unique ID.
tenant_connection_id String(UUID) tenant_connection unique ID
network_id String(UUID) Network unique id.
mac_address String() mac address assigned with port.
fixed_ips Array(Object) List of fixes IP addresses assign to port.
ip_address String(cidr) The IP address assign to port within subnet.
subnet_id String(UUID) The ID of subnet from which IP address is allocated.
allowed_address_pairs Array(Object) Allowed address pairs
ip_address String(cidr) IP address
mac_address String() MAC address

Sample Request and Response

Sample API request

Request URI

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

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

{
  "address_assingments": [
    {
      "mac_address": "fa:16:3e:c4:24:45",
      "fixed_ips": [
        {
          "ip_address": "192.168.30.6",
          "subnet_id": "f82b1e98-aca0-4188-a6f3-8827c4acb869"
        }
      ],
      "allowed_address_pairs": [],
      "network_id": "77cfc6b0-d032-4e5a-b6fb-4cce2537f4d1",
      "tenant_connection_request_id": "5fbcc350-bd33-11e7-afb6-0050569c850d",
      "tenant_connection_id": "2a23e5a6-bd34-11e7-afb6-0050569c850d"
    },
    {
      "mac_address": "fa:16:3e:64:74:bf",
      "fixed_ips": [
        {
          "ip_address": "192.168.30.4",
          "subnet_id": "f82b1e98-aca0-4188-a6f3-8827c4acb869"
        }
      ],
      "allowed_address_pairs": [],
      "network_id": "77cfc6b0-d032-4e5a-b6fb-4cce2537f4d1"
    }
  ]
}

Example error message

HTTP request

GET /v2.0/tenant_connection_requests/{tenant_connection_request_id}/address_assignments 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"
}