Private Network(UVPC)

Display virtual network card information - DescribeNetworkInterface


Display virtual network card information


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeNetworkInterface.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.Yes
VPCIdstringBelonging VPCNo
SubnetIdstringSubnet OwnershipNo
InterfaceId.NstringVirtual Network Card ID, can specify 0~nNo
OnlyDefaultbooleanIf set to true, only the default network card will be returned. The default is set to false.No
NoRecycledbooleanIf set to true, filter the network cards bound in the recycle bin host. The default is false.No
TagstringBusiness GroupNo
LimitintDefault is 20No
OffsetintDefault is 0No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
NetworkInterfaceSetarray[NetworkInterface]Virtual Network Card InformationYes
TotalCountintTotal Number of Virtual Network CardsNo

Data Model


Field NameTypeDescription InformationRequired
InterfaceIdstringVirtual Network Card Resource IDYes
VPCIdstringBelonging VPCYes
SubnetIdstringSubnet OwnershipYes
PrivateIpSetarray[string]Associate with the internal network IP. Currently, a network card only supports binding with one internal network IP.Yes
MacAddressstringAssociate MacYes
StatusintBinding StatusYes
PrivateIparray[UNIIpInfo]Intranet IP information of the network cardNo
NamestringVirtual Network Card NameNo
NetmaskstringPrivate Network IP MaskNo
GatewaystringDefault GatewayNo
AttachInstanceIdstringBind Instance Resource IDNo
DefaultbooleanIs it the default network card bound to the instance? false: No true: YesNo
CreateTimeintCreation TimeNo
TagstringBusiness GroupNo
EIPIdSetarray[string]EIP ID information bound to the virtual network cardNo
FirewallIdSetarray[string]Information of the firewall ID bound to the virtual network cardNo
PrivateIpLimitUNIQuotaInfoInformation on the internal IP quota of the network cardNo


Field NameTypeDescription InformationRequired
IpTypestringIP Type SecondaryIp/PrimaryIpNo
IpAddrarray[string]IP AddressNo


Field NameTypeDescription InformationRequired
PrivateIpCountintThe number of private IPs owned by the network cardNo
PrivateIpQuotaintIntranet IP quota of the network cardNo


Request Example

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

Response Example

  "Action": "DescribeNetworkInterfaceResponse",
  "NetworkInterfaceSet": [
      "AttachInstanceId": "",
      "CreateTime": 1513655538,
      "Default": false,
      "Gateway": "",
      "InterfaceId": "uni-g10pte",
      "MacAddress": "52:54:00:16:F2:A7",
      "Name": "chd-nn",
      "Netmask": "",
      "PrivateIpSet": [
      "Remark": "nn",
      "Status": 0,
      "SubnetId": "subnet-pnctmk",
      "Tag": "Default",
      "VPCId": "uvnet-lksdw0"
  "RetCode": 0,
  "TotalCount": 6
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.