Listing NICs of an ECS

Function

This API is used to list NICs of an ECS.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permissions listed below are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ecs:cloudServers:listServerInterfaces	list	instance *	-	ecs:cloudServers:get	-

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	Definition Specifies ECS NICs. For details, see Table 3. Range N/A
attachableQuantity	Object	Definition Specifies the number of NICs that can be attached to an ECS. For details, see Table 4. Range N/A

**Table 3** **interfaceAttachments** field description
Parameter	Type	Description
port_state	String	Definition Specifies the NIC port status. Range N/A
fixed_ips	Array of objects	Definition Specifies private IP addresses for NICs. For details, see Table 5. Range N/A
net_id	String	Definition Specifies the network ID (network_id) that the NIC port belongs to. Range N/A
port_id	String	Definition Specifies the NIC port ID. Range N/A
mac_addr	String	Definition Specifies the MAC address of the NIC. Range N/A
delete_on_termination	Boolean	Definition Specifies whether to delete a NIC when detaching it. Range true: Delete the NIC. false: Do not delete the NIC.
driver_mode	String	Definition Specifies the NIC driver type, which is virtio by default. This parameter is a reserved field. Range N/A
min_rate	Integer	Definition Specifies the minimum NIC bandwidth. Range N/A
multiqueue_num	Integer	Definition Specifies the number of queues. Range 1-64
pci_address	String	Definition Specifies the BDF number of the NIC in Linux GuestOS. NOTE: If the NIC is not supported, no information will be returned. Range N/A

**Table 4** **attachableQuantity** field description
Parameter	Type	Description
free_nic	Integer	Definition Specifies the remaining number of NICs that can be attached to an ECS. Range N/A

**Table 5** **fixed_ips** field description
Parameter	Type	Description
subnet_id	String	Definition Specifies the subnet of the NIC private IP address. Range N/A
ip_address	String	Definition Specifies the NIC private IP address. Range N/A

Example Request

List 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"        }
    ]
}