Querying NICs of an ECS¶

Function¶

This API is used to query NICs of an ECS.

URI¶

GET /v1/{project_id}/cloudservers/{server_id}/os-interface

Table 1 describes the parameters in the URI.

**Table 1** Parameter description¶
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID.
server_id	Yes	Specifies the ECS ID.

Request¶

None

Response¶

Table 2 describes the response parameters.

**Table 2** Response parameters¶
Parameter	Type	Description
interfaceAttachments	Array of objects	Specifies ECS NICs. For details, see Table 3.

**Table 3** **interfaceAttachments** field description¶
Parameter	Type	Description
port_state	String	Specifies the NIC port status.
fixed_ips	Array of objects	Specifies private 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 NIC port ID.
mac_addr	String	Specifies the MAC address of the NIC.

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

Example Request¶

Query NICs of an ECS.

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-interface

Example Response¶

{
    "interfaceAttachments": [
        {
            "port_state": "ACTIVE",
            "fixed_ips": [
                {
                    "subnet_id": "ba31e1f5-fa76-4530-862c-5176fad033cf",
                    "ip_address": "192.168.0.33"
                }
            ],
            "net_id": "610a4af2-1d90-4d2b-8057-dc238b26febf",
            "port_id": "04819c0a-6a07-44b6-945e-fb932071888e",
            "mac_addr": "fa:16:3e:45:65:c4"        }
    ]
}

Returned Values¶

See Returned Values for General Requests.

last updated: 2024-11-08 14:21 UTC - commit: c986e0f7c0392c4cd98c9cb56ea7f6b22cacb972