Querying Details About a Specified NIC of an ECS¶

Function¶

This API is used to query details about an NIC based on the NIC ID.

URI¶

GET /v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}

GET /v2/{project_id}/servers/{server_id}/os-interface/{port_id}

Table 1 describes the parameters in the URI.

**Table 1** Parameter description¶
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.
server_id	Yes	Specifies the ECS ID.
port_id	Yes	Specifies the port ID of the NIC.

Request¶

None

Response¶

Table 2 describes the response parameters.

**Table 2** Response parameters¶
Parameter	Type	Description
interfaceAttachment	Object	Specifies ECS NICs. For details, see Table 3.

**Table 3** **interfaceAttachment** field description¶
Parameter	Type	Description
port_state	String	Specifies the NIC port status.
fixed_ips	Array of objects	Specifies IP addresses for NICs. For details, see Table 4.
net_id	String	Specifies the network ID to which the NIC port belongs.
port_id	String	Specifies the ID of the NIC port.
mac_addr	String	Specifies the MAC address of the NIC.

**Table 4** **fixed_ips** field description¶
Parameter	Type	Description
subnet_id	String	Specifies the ID of the subnet used by the NIC.
ip_address	String	Specifies the NIC IP address.

Example Request¶

Query details about an NIC based on the specified NIC ID.

GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{port_id}
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}

Example Response¶

{
    "interfaceAttachment":
{
        "port_state": "ACTIVE",
        "fixed_ips": [
{
                "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef",
                "ip_address": "192.168.1.3"
                    }
            ],
        "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
        "port_id": "ce531f90-199f-48c0-816c-13e38010b442",
        "mac_addr": "fa:16:3e:4c:2c:30"
                    }
                    }

Returned Values¶

See Returned Values for General Requests.

last updated: 2024-11-13 15:01 UTC - commit: cd2be11cc19cf5d8dfd3a6caf2d1429e1bff9d8a