Display virtual network card information - DescribeNetworkInterface

Overview

Display virtual network card information

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeNetworkInterface`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	Yes
VPCId	string	Belonging VPC	No
SubnetId	string	Subnet Ownership	No
InterfaceId.N	string	Virtual Network Card ID, can specify 0~n	No
OnlyDefault	boolean	If set to true, only the default network card will be returned. The default is set to false.	No
NoRecycled	boolean	If set to true, filter the network cards bound in the recycle bin host. The default is false.	No
Tag	string	Business Group	No
Limit	int	Default is 20	No
Offset	int	Default is 0	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
NetworkInterfaceSet	array[NetworkInterface]	Virtual Network Card Information	Yes
TotalCount	int	Total Number of Virtual Network Cards	No

Data Model

NetworkInterface

Field Name	Type	Description Information	Required
InterfaceId	string	Virtual Network Card Resource ID	Yes
VPCId	string	Belonging VPC	Yes
SubnetId	string	Subnet Ownership	Yes
PrivateIpSet	array[string]	Associate with the internal network IP. Currently, a network card only supports binding with one internal network IP.	Yes
MacAddress	string	Associate Mac	Yes
Status	int	Binding Status	Yes
PrivateIp	array[UNIIpInfo]	Intranet IP information of the network card	No
Name	string	Virtual Network Card Name	No
Netmask	string	Private Network IP Mask	No
Gateway	string	Default Gateway	No
AttachInstanceId	string	Bind Instance Resource ID	No
Default	boolean	Is it the default network card bound to the instance? false: No true: Yes	No
CreateTime	int	Creation Time	No
Remark	string	Note	No
Tag	string	Business Group	No
EIPIdSet	array[string]	EIP ID information bound to the virtual network card	No
FirewallIdSet	array[string]	Information of the firewall ID bound to the virtual network card	No
PrivateIpLimit	UNIQuotaInfo	Information on the internal IP quota of the network card	No

UNIIpInfo

Field Name	Type	Description Information	Required
IpType	string	IP Type SecondaryIp/PrimaryIp	No
IpAddr	array[string]	IP Address	No

UNIQuotaInfo

Field Name	Type	Description Information	Required
PrivateIpCount	int	The number of private IPs owned by the network card	No
PrivateIpQuota	int	Intranet IP quota of the network card	No

Example

Request Example

{
	"Action": "DescribeNetworkInterface",
	"Region": "pre",
	"ProjectId": "test",
	"InterfaceId.0": "uni-g10pte"
}

Response Example

{
  "Action": "DescribeNetworkInterfaceResponse",
  "NetworkInterfaceSet": [
    {
      "AttachInstanceId": "",
      "CreateTime": 1513655538,
      "Default": false,
      "Gateway": "10.21.0.1",
      "InterfaceId": "uni-g10pte",
      "MacAddress": "52:54:00:16:F2:A7",
      "Name": "chd-nn",
      "Netmask": "255.255.0.0",
      "PrivateIpSet": [
        "10.21.69.26"
      ],
      "Remark": "nn",
      "Status": 0,
      "SubnetId": "subnet-pnctmk",
      "Tag": "Default",
      "VPCId": "uvnet-lksdw0"
    }
  ],
  "RetCode": 0,
  "TotalCount": 6
}

DescribeNetworkAclEntry DescribeRouteTable