接口功能介绍
查询网卡信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1.使用限制，本接口只支持在华东1、上海32、上海33、上海36、南宁23、南昌19、青岛20、青岛21、武汉41资源池进行公测
URI
GET /v4/ecs/ports/show
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| networkInterfaceID | 是 | String | 网卡ID，您可以查看弹性网卡-弹性网卡基本知识来了解弹性网卡 获取： 查 查询弹性网卡列表 创 创建弹性网卡 |
port-dasgdwevf |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误信息 | success | |
| description | String | 失败时的错误描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| networkInterfaceName | String | 虚拟网名称 | 虚拟网卡1 | |
| 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 | Object | 关联的eip信息 | associatedEip |
表 associatedEip
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 弹性公网IP的ID | eip-r5i4zghgvq | |
| name | String | 弹性公网IP的名称 | v-test-2 |
枚举参数
无
请求示例
请求url
示例：查询网卡的详细信息
GET .../v4/ecs/ports/show?regionID=bb9fdb42056f11eda1610242ac110002&networkInterfaceID=port-dasgdwevf
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"networkInterfaceID": "port-r5i4zghgvq",
"networkInterName": "虚拟网卡1",
"description": "",
"role": "primary",
"vpcID": "vpc-r5i4zghgvq",
"subnetID": "subnet-r5i4zghgvq",
"macAddress": "fa:16:3e:14:69:3a",
"sanityCheck": "mac",
"primaryPrivateIp": "192.168.3.2",
"deviceId": "router-pap5em141g",
"deviceType": "dhcp"
},
"message":"success",
"descritption": "成功",
"statusCode":800,
"errorCode":"SUCCESS"
}
状态码
请参考 状态码
错误码
请参考 错误码
