接口功能介绍
查询虚拟网卡列表
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1.使用限制，本接口只支持在华东1、上海32、上海33、上海36、南宁23、南昌19、青岛20、青岛21、武汉41资源池进行公测
2.当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
GET /v4/ecs/ports/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| vpcID | 否 | String | 虚拟私有云ID，您可以查看产品定义-虚拟私有云来了解虚拟私有云 获取： 查 查询VPC列表 创 创建VPC 注：在多可用区类型资源池下，vpcID通常以“vpc-”开头，非多可用区类型资源池vpcID为uuid格式 |
vpc-r5i4zghgvq | |
| deviceID | 否 | String | 关联设备id，即云主机id，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 |
a628a7d9-ef97-3b16-8a0a-4a794fcdxxxx | |
| subnetID | 否 | String | 所属子网ID，您可以查看产品定义-子网来了解子网 获取： 查 查询子网列表 创 创建子网 |
subnet-r5i4zghgvq | |
| pageNumber | 否 | String | 页码，取值范围：正整数（≥1），注：默认值为1。建议使用pageNo，该字段未来将会下线。 | 6 | |
| pageSize | 否 | String | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 5 | |
| pageNo | 否 | String | 页码，取值范围：正整数（≥1），注：默认值为1 | 6 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息, 英文 | success | |
| description | String | statusCode为900时的错误信息，中文 | 成功 | |
| returnObj | Array of Objects | 接口业务数据 | returnObj | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| networkInterfaceName | String | 虚拟网名称 | nic-test01 | |
| networkInterfaceID | String | 虚拟网id | port-r5i4zghgvq | |
| vpcID | String | 所属vpc | vpc-3ggxpbjxxx | |
| subnetID | String | 所属子网id | subnet-h0cbw19xxx | |
| role | Integer | 网卡类型: 0 主网卡， 1 弹性网卡 | 0 | |
| macAddress | String | mac地址 | fa:16:3e:e5:fa:xx | |
| primaryPrivateIp | String | 主ip | 10.2.7.209 | |
| ipv6Addresses | Array of Strings | ipv6地址 | ["240e:978:497c:ec00:cd74:fd9d:c45d:4131"] | |
| instanceID | String | 关联的设备id | a628a7d9-ef97-3b16-8a0a-4a794fcdxxxx | |
| instanceType | String | 设备类型 VM, BM, Other | VM | |
| description | String | 描述 | nic_create_test | |
| securityGroupIds | Array of Strings | 安全组ID列表 | ["sg-n7nu88xfbq"] | |
| secondaryPrivateIps | Array of Strings | 辅助私网IP | ["172.16.0.210"] | |
| adminStatus | String | 是否启用DOWN, UP | UP |
表 associatedEip
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 弹性公网IP的ID | eip-prsusofcys | |
| name | String | 弹性公网IP的名称 | eip-b05c2ec8 |
枚举参数
无
请求示例
请求url
示例：查询资源池华东1的网卡列表
GET .../v4/ecs/ports/list?regionID=bb9fdb42056f11eda1610242ac110002
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "SUCCESS",
"description": "成功",
"returnObj": [{
"networkInterfaceName": "",
"networkInterfaceID": "port-ecr9sao3sw",
"vpcID": "vpc-swvh3ocspn",
"subnetID": "subnet-k5mcqfaesp",
"role": 0,
"macAddress": "fa:16:3e:67:2a:c9",
"primaryPrivateIp": "192.168.2.6",
"ipv6Addresses": null,
"instanceID": "f1502e6a-165e-a8ef-0b98-dbdcc87a33be",
"instanceType": "VM",
"description": "成功",
"securityGroupIds": ["sg-u9o93k4p4o"],
"secondaryPrivateIps": null,
"adminStatus": "UP",
"associatedEip": null
}, {
"networkInterfaceName": "",
"networkInterfaceID": "port-a0pye6io4b",
"vpcID": "vpc-9h723rhdxq",
"subnetID": "subnet-dq739e2f4j",
"role": 0,
"macAddress": "fa:16:3e:04:77:61",
"primaryPrivateIp": "192.168.0.22",
"ipv6Addresses": ["240e:978:4920:df00:8c19:9495:a6d2:d249"],
"instanceID": "5a047e05-cc2f-bfe7-f12f-1d40da338a2e",
"instanceType": "VM",
"description": "成功",
"securityGroupIds": ["sg-4druj6hmec"],
"secondaryPrivateIps": null,
"adminStatus": "UP",
"associatedEip": {
"id": "eip-0xlnvz7bis",
"name": "eip-177f16b9"
}
}],
"currentCount": 2,
"totalCount": 4604,
"totalPage": 2302
}
状态码
请参考 状态码
错误码
请参考 错误码
