• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Interfaces
  6. Querying Details About Added NICs

Querying Details About Added NICs

Function Description

This interface is used to query detailed information about specified NICs that have been successfully added to a specified ECS.

Interface Format

Method

URI

Description

GET

/v2/{tenant_id}/servers/{server_id}/os-interface/{attachment_id}

/v2.1/{tenant_id}/servers/{server_id}/os-interface/{attachment_id}

Queries NIC information for a specified ECS.

Restrictions

N/A

Expanded Interface

N/A

Request Parameter

N/A

Response Parameter

Parameter

Type

Mandatory

Description

interfaceAttachment

Dict

Yes

Specifies the NIC attachment information.

interfaceAttachment parameter description

Parameter

Type

Mandatory

Description

port_state

String

Yes

Specifies the port status.

fixed_ips

List(fixed_ip)

Yes

Specifies IP address information, including the subnet ID and IP address.

port_id

UUID

Yes

Specifies the port ID.

net_id

UUID

Yes

Specifies the network ID.

mac_addr

String

Yes

Specifies the MAC address.

Request Example

GET /v2/b23b579f08c84228b9b4673c46f0c442/servers/f6c61c09-c754-4874-9371-c19db89678a5/os-interface/1f951893-55c4-41fd-a993-5b1b25911674

GET /v2.1/b23b579f08c84228b9b4673c46f0c442/servers/f6c61c09-c754-4874-9371-c19db89678a5/os-interface/1f951893-55c4-41fd-a993-5b1b25911674

Response Example

{
    "interfaceAttachment": 
        {
            "port_state": "ACTIVE",
            "fixed_ips": [
                {
                    "subnet_id": "8c1aaddf-e49e-4f28-93ea-ca9f0b3c6240",
                    "ip_address": "10.0.0.4"
                }
            ],
            "port_id": "1f951893-55c4-41fd-a993-5b1b25911674",
            "net_id": "c4485ba1-283a-4f5f-8868-0cd46cdda52f",
            "mac_addr": "fa:16:3e:af:fa:14"
        }
  }

Returned Values

For details, see section General Request Returned Values.

Error Code

For details, see section General Request Returned Values.