展示虚拟网卡信息 - DescribeNetworkInterface

简介

展示虚拟网卡信息

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `DescribeNetworkInterface`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	Yes
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	Yes
VPCId	string	所属VPC	No
SubnetId	string	所属子网	No
InterfaceId.N	string	虚拟网卡ID,可指定 0~n	No
OnlyDefault	boolean	若为true 只返回默认网卡默认为false	No
NoRecycled	boolean	若为true 过滤绑定在回收站主机中的网卡。默认为false。	No
Tag	string	业务组	No
Limit	int	默认为20	No
Offset	int	默认为0	No

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
NetworkInterfaceSet	array[NetworkInterface]	虚拟网卡信息	Yes
TotalCount	int	虚拟网卡总数	No

数据模型

NetworkInterface

字段名	类型	描述信息	必填
InterfaceId	string	虚拟网卡资源ID	Yes
VPCId	string	所属VPC	Yes
SubnetId	string	所属子网	Yes
PrivateIpSet	array[string]	关联内网IP。当前一个网卡仅支持绑定一个内网IP	Yes
MacAddress	string	关联Mac	Yes
Status	int	绑定状态	Yes
PrivateIp	array[UNIIpInfo]	网卡的内网IP信息	No
Name	string	虚拟网卡名称	No
Netmask	string	内网IP掩码	No
Gateway	string	默认网关	No
AttachInstanceId	string	绑定实例资源ID	No
Default	boolean	是否是绑定实例的默认网卡 false:不是 true:是	No
CreateTime	int	创建时间	No
Remark	string	备注	No
Tag	string	业务组	No
EIPIdSet	array[string]	虚拟网卡绑定的EIP ID信息	No
FirewallIdSet	array[string]	虚拟网卡绑定的防火墙ID信息	No
PrivateIpLimit	UNIQuotaInfo	网卡的内网IP配额信息	No

UNIIpInfo

字段名	类型	描述信息	必填
IpType	string	ip类型 SecondaryIp/PrimaryIp	No
IpAddr	array[string]	ip 地址	No

UNIQuotaInfo

字段名	类型	描述信息	必填
PrivateIpCount	int	网卡拥有的内网IP数量	No
PrivateIpQuota	int	网卡内网IP配额	No

示例

请求示例


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

响应示例


{
  "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
}