Show Nic Physical Port

Overview

This API shows the specified NicPhysicalPort information for specified server.

Classification

  • Show

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/{tenant_id}/servers/{server_id}/nic_physical_ports/{nic_physical_port_id}

HTTP Request Header

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

HTTP Request Body

  • none

Response Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
tenant_id URL UUID ID for the tenant. required - Terminate 403, 404
server_id URL UUID ID for the server. required - Terminate 404
nic_physical_port_id URL UUID ID for the network interface port. required - Terminate 404
token Header Authentication token string Keystone authentication token. required - Terminate 401

Response

HTTP Response Header

Format

HTTP/1.1 200 OK
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 normal end
400 specified parameter is invalid
401 unauthorized
403 tenant is not available
405 request URL or method is invalid
500 compute fault

HTTP Response Body

Format

{
  "nic_physical_port": "<nic_physical_port>"
}

Parameter List

Response Parameters
item format   description
nic_physical_port NicPhysicalPort   Network Interface Port Information.

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/8b59526b-daf5-46db-9c44-e77c0a34bf2c/nic_physical_ports/ab17a82d-e9a5-4e95-9b18-de3f8a47670f

HTTP Request Header

GET /v2/b322a85578de48beba0f92acce57869b/servers/8b59526b-daf5-46db-9c44-e77c0a34bf2c/nic_physical_ports/ab17a82d-e9a5-4e95-9b18-de3f8a47670f HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

HTTP Request Body

  • none

Sample API Response

HTTP Response Header

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

HTTP Response Body

{
  "nic_physical_port": {
    "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
    "mac_addr": "0a:31:c1:d5:6d:9c",
    "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
    "plane": "data",
    "attached_ports": [
      {
        "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
        "network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
        "fixed_ips": [
          {
            "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
            "ip_address": "192.168.10.2"
          }
        ]
      }
    ],
    "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
  }
}