查询物理机网卡信息
更新时间 2025-03-11 18:30:19
最近更新时间: 2025-03-11 18:30:19
接口功能介绍
根据物理机实例ID查询网卡信息列表
接口约束
无
URI
GET /v4/ebm/instance-interface-list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 您可以调用资源池列表查询获取最新的天翼云资源池列表 |
73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| azName | 是 | String | 可用区名称，您可以查看地域和可用区来了解可用区 您可以调用资源池可用区查询 注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default） |
default | |
| instanceUUID | 是 | String | 实例UUID | ss-qyjtenwqho0gfztts5vscc2l5efi |
请求参数
请求头header
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.InterfaceList.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Array of Objects | 返回参数，参考表returnObj | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| interfaceUUID | String | 网卡UUID | ifg-flu2fonep4dcsxhesj9qsflktfst | |
| vpcUUID | String | 网络UUID | vpcUUID | |
| subnetUUID | String | 子网UUID | subnet-pu20dc9vur | |
| portUUID | String | Port UUID | port-cgieldjj2m | |
| ipv4 | String | IPv4地址 | 192.168.0.14 | |
| ipv4Gateway | String | IPv4网关 | 192.168.0.1 | |
| ipv6 | String | IPv6地址 | ||
| ipv6Gateway | String | IPv6网关 | fe80::f816:3eff:fe1d:afe7 | |
| vipUUIDList | Array of Strings | vip UUID列表 | [] | |
| vipList | Array of Strings | vip列表 | [] | |
| securityGroups | Array of Objects | 安全组信息列表 | securityGroups | |
| master | Boolean | 是否为主网卡 | true |
表securityGroups
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupID | String | 安全组UUID | sg-erztepgw7d | |
| securityGroupName | String | 安全组名称 | Default-Security-Group |
请求示例
Query
/v4/ebm/instance-interface-list?regionID=bb9fdb42056f11eda1610242ac110002&azName=az1&instanceUUID=ss-rtkjng87ovlyda013spdb0shvfaj
响应示例
{
"returnObj": [
{
"portUUID": "port-cgieldjj2m",
"securityGroups": [
{
"securityGroupID": "sg-erztepgw7d",
"securityGroupName ": "Default-Security-Group"
}
],
"subnetUUID ": "subnet-pu20dc9vur",
"vipUUIDList ": null,
"ipv4 ": "192.168.0.14",
"ipv6 ": "",
"ipv4Gateway ": "192.168.0.1",
"vpcUUID ": "vpc-sbuoxwhhxj",
"ipv6Gateway ": "fe80::f816:3eff:fe1d:afe7",
"interfaceUUID ": "ifg-flu2fonep4dcsxhesj9qsflktfst",
"vipList ": null
},
{
"portUUID ": "port-r3ayoglt65",
"securityGroups ": [
{
"securityGroupID ": "sg-erztepgw7d",
"securityGroupName ": "Default-Security-Group"
}
],
"subnetUUID ": "subnet-pu20dc9vur",
"vipUUIDList ": null,
"ipv4 ": "192.168.0.21",
"ipv6 ": "",
"ipv4Gateway ": "192.168.0.1",
"vpcUUID ": "vpc-sbuoxwhhxj",
"ipv6Gateway ": "fe80::f816:3eff:fe1d:afe7",
"interfaceUUID ": "ifg-qhef5sopgzeptfyy84vxnuoix4gi",
"vipList ": null
}
],
"statusCode ": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.InterfaceList.NotValid | 请求参数非法 |
| Ebm.Instance.NotFound | 物理机不存在 |
| Ebm.InterfaceList.NotFound | 网卡不存在 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
