Private NICs
A Private NIC is the network interface that connects an Instance to a Private Network. An Instance can have multiple private NICs at the same time, but each NIC must belong to a different Private Network.
List all private NICs
List all private NICs of a specified Instance. Some private NICs, such as those in deleting, detaching, or in error state are not listed. We strongly recommend migrating to v2alpha1 to retrieve all private NICs.
path Parameters
zoneThe zone you want to target
server_idInstance to which the private NIC is attached.
query Parameters
tagsPrivate NIC tags.
per_pageA positive integer lower or equal to 100 to select the number of items to return.
pageA positive integer to choose the page to return.
List all private NICs › Responses
total_countCreate a private NIC connecting an Instance to a Private Network
Create a private NIC connecting an Instance to a Private Network. Some private NICs, such as those in deleting, detaching, or in error state are not listed in v1. Therefore, you may encounter quota limits errors when creating a new private NIC, even if your visible count is below the threshold. We strongly recommend migrating to v2alpha1 to see all private NICs.
path Parameters
zoneThe zone you want to target
server_idUUID of the Instance the private NIC will be attached to.
Create a private NIC connecting an Instance to a Private Network › Request Body
private_network_idUUID of the private network where the private NIC will be attached.
tagsPrivate NIC tags.
ipam_ip_idsUUID of IPAM ips, to be attached to the instance in the requested private network. (UUID format)
Create a private NIC connecting an Instance to a Private Network › Responses
Get a private NIC
Get private NIC properties.
path Parameters
zoneThe zone you want to target
server_idInstance to which the private NIC is attached.
private_nic_idPrivate NIC unique ID.
Get a private NIC › Responses
Delete a private NIC
path Parameters
zoneThe zone you want to target
server_idInstance to which the private NIC is attached.
private_nic_idPrivate NIC unique ID.
Delete a private NIC › Responses
Update a private NIC
Update one or more parameter(s) of a specified private NIC.
path Parameters
zoneThe zone you want to target
server_idUUID of the Instance the private NIC will be attached to.
private_nic_idPrivate NIC unique ID.
Update a private NIC › Responses
idPrivate NIC unique ID.
server_idInstance to which the private NIC is attached.
private_network_idPrivate Network the private NIC is attached to.
mac_addressPrivate NIC MAC address.
statePrivate NIC state.
tagsPrivate NIC tags.
creation_datePrivate NIC creation date. (RFC 3339 format)
zoneThe zone in which the Private NIC is located.
ipam_ip_idsThe list of IPAM IPs associated with this private NIC. (UUID format)