接口功能介绍
查询网卡信息
接口约束
无
URI
GET /v4/ports/show
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池ID | |
| networkInterfaceID | String | 是 | 虚拟网卡id | port-dasgdwevf |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object | 接口业务数据 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| networkInterfaceName | String | 虚拟网名称 | |
| networkInterfaceID | String | 虚拟网id | port-r5i4zghgvq |
| vpcID | String | 所属vpc | |
| subnetID | String | 所属子网id | |
| role | Integer | 网卡类型: 0 主网卡， 1 弹性网卡 | |
| macAddress | String | mac地址 | |
| primaryPrivateIp | String | 主ip | |
| ipv6Addresses | Array of String | ipv6地址 | |
| instanceID | String | 关联的设备id | |
| instanceType | String | 设备类型 VM, BM, Other | |
| description | String | 描述 | |
| securityGroupIds | Array of String | 安全组ID列表 | |
| secondaryPrivateIps | Array of String | 辅助私网IP | |
| adminStatus | String | 是否启用DOWN, UP | |
| associatedEip | Object | 关联的eip信息 |
表 associatedEip
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| id | String | eip id | eip-r5i4zghgvq |
| name | String | eip名称 | v-test-2 |
请求示例
GET /v4/ports/show?regionID=xxxx&networkInterfaceID=port-r5i4zghgvq
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"networkInterfaceName": "",
"networkInterfaceID": "port-qbi1i7d7h5",
"vpcID": "vpc-s3evrh4u6w",
"subnetID": "subnet-m375xhghsb",
"role": 0,
"macAddress": "fa:16:3e:fd:74:8d",
"primaryPrivateIp": "172.16.0.10",
"ipv6Addresses": [
"240e:978:4912:800:710d:3e4a:ab3f:76d3"
],
"instanceID": "141d0876-1bc9-4e00-8bc9-285e6c626e40",
"instanceType": "VM",
"description": "",
"securityGroupIds": [
"sg-y8d7gm5wwn"
],
"secondaryPrivateIps": null,
"adminStatus": "UP",
"associatedEip": null
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
