Querying the Details of a Supplementary Network Interface

project_id

Yes

String

Definition:

ID of the project that a supplementary network interface belongs to. For details about how to obtain a project ID, see Obtaining a Project ID.

Range:

N/A

sub_network_interface_id

Yes

String

Definition:

ID of a supplementary network interface.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

sub_network_interface

SubNetworkInterface object

Definition:

Response body for querying details about a supplementary network interface.

Range:

N/A

id

String

Definition:

ID of a supplementary network interface. After a supplementary network interface is created, a supplementary network interface ID is generated, which uniquely identifies the supplementary network interface.

Range:

The value is in UUID format with hyphens (-).

virsubnet_id

String

Definition:

ID of the virtual subnet that a supplementary network interface is located.

Range:

The value is in UUID format with hyphens (-).

private_ip_address

String

Definition:

Private IPv4 address of a supplementary network interface.

Range:

N/A

ipv6_ip_address

String

Definition:

Private IPv6 address of a supplementary network interface.

Range:

N/A

mac_address

String

Definition:

MAC address of a supplementary network interface.

Range:

The value is a valid MAC address assigned by the system randomly.

parent_device_id

String

Definition:

Device ID of the host network interface that a supplementary network interface is attached to.

Range:

The value is in UUID format with hyphens (-).

parent_id

String

Definition:

ID of the elastic network interface that a supplementary network interface is attached to.

Range:

The value is in UUID format with hyphens (-).

description

String

Definition:

Description of a supplementary network interface.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

vpc_id

String

Definition:

ID of the VPC that a supplementary network interface belongs to.

Range:

The value is in UUID format with hyphens (-).

vlan_id

Integer

Definition:

VLAN ID of a supplementary network interface.

Range:

1 to 4094

security_groups

Array of strings

Definition:

IDs of the security groups that a supplementary network interface is associated with. For example, "security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"].

Range:

If this parameter is not specified in the request, the supplementary network interface is automatically associated with the default security group after being created.

tags

Array of ResponseTag objects

Definition:

Tags of a supplementary network interface, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.

Range:

N/A

project_id

String

Definition:

ID of the project that a supplementary network interface belongs to.

Range:

N/A

created_at

String

Definition:

Time when a supplementary network interface was created.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

allowed_address_pairs

Array of AllowedAddressPair objects

Definition:

IP/MAC address pair list of a supplementary network interface. For details, see the AllowedAddressPair object list.

Range:

N/A

state

String

Definition:

Status of a supplementary network interface.

Range:

• NORMAL: The supplementary network interface is attached to an elastic network interface.

• UNBOUND: The supplementary network interface is not attached to an elastic network interface.

instance_id

String

Definition:

ID of the cloud service instance that a supplementary network interface is attached to, for example, RDS instance ID.

Range:

N/A

instance_type

String

Definition:

Type of the cloud service instance that a supplementary network interface is attached to, for example, RDS.

Range:

N/A

scope

String

Definition:

Public network egress information of the site where a supplementary network interface works.

Range:

• center: default value, indicating the central AZ.

• AZ ID: a specific AZ

security_enabled

Boolean

Definition:

Whether the security option is enabled for a supplementary network interface. If the option is not enabled, the security group does not take effect.

Range:

N/A

key

String

Definition:

Tag key.

Range:

• A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.

• Each tag key of a resource must be unique.

• The value can contain:

  • Letters

  • Digits

  • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

  • Chinese characters

value

String

Definition:

Tag value.

Range:

• Each value can contain a maximum of 255 Unicode characters and can be left blank.

• The value can contain:

  • Letters

  • Digits

  • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

  • Chinese characters

ip_address

String

Definition:

IP address.

Constraints:

Configure a dedicated security group if a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs.

Range:

Single IP address, for example, 192.168.21.25

A CIDR block, for example, 192.168.21.0/24

Default Value:

N/A

mac_address

String

Definition:

MAC address.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

200

Normal response to the GET operation. For more status codes, see Status Codes.