查询弹性网卡列表
更新时间:2022-11-10
接口描述
查询弹性网卡列表。
请求结构
JSON
1GET /v1/vpc/eni?vpcId={vpcId}&name={name}&instanceId={instanceId}&keywordType=&keyword=&privateIpAddress={ip1,ip2} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
vpcId | String | 是 | Query参数 | 弹性网卡所属的VPC的ID |
subnetId | String | 否 | Query参数 | 弹性网卡所属的子网ID |
instanceId | String | 否 | Query参数 | 弹性网卡挂载主机ID |
name | String | 否 | Query参数 | 弹性网卡名称 |
privateIpAddress | List<String> | 否 | Query参数 | 弹性网卡内网IP地址,支持单IP或者多IP查询(多IP用英文逗号隔开);单IP后缀模糊匹配,多IP精确匹配 |
keywordType | String | 否 | Query参数 | 过滤类型:eniId、 sgId、privateIp,分别表示弹性网卡ID、安全组ID、内网IP |
keyword | String | 否 | Query参数 | 过滤值 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
result | List<Eni> | 弹性网卡列表 |
orderBy | String | 排序字段 |
order | String | 排序顺序 |
pageNo | Integer | 页码 |
pageSize | Integer | 每页结果数 |
totalCount | Integer | 结果总数 |
请求示例
JSON
1GET /v1/vpc/eni?vpcId=vpc-w7redbfj5frg&name=testeni&maxKeys=1 HTTP/1.1
2Host: bec.baidubce.com
3authorization: bce-auth-v1/c3119080364d11e8912505e5e0ae9978/2022-04-02T08:14:25Z/3600/host;x-bce-account;x-bce-client-ip;x-bce-date;x-bce-request-id;x-bce-security-token/xxx
返回示例
JSON
1HTTP/1.1 200 OK
2x-bce-request-id: 7e789a40-adac-414a-8bd4-916d6be61112
3Date: Mon, 02 Apr 2022 08:14:25 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "result": [
9 {
10 "eniId": "eni-cuij4grvpkyf",
11 "name": "testeni",
12 "description": "",
13 "vpcId": "vpc-w7redbfj5frg",
14 "subnetId": "sbn-0apxrzlye54r",
15 "securityGroupIds": [
16 "sg-dzn5bikn",
17 "sg-2a7icbeg"
18 ],
19 "ipSet": [
20 {
21 "primary": true,
22 "privateIpAddress": "192.168.0.6"
23 }
24 ],
25 "status": "available",
26 "macAddress": "xx:xx:xx:xx:xx:xx",
27 "instanceId": "vm-xxxxx",
28 "regionId": "cn-hangzhou-cm",
29 "createTime": "2022-04-01T01:34:01Z"
30 }
31
32 ],
33 "orders": null,
34 "orderBy": "createTime",
35 "order": "desc",
36 "pageNo": 1,
37 "pageSize": 1000,
38 "totalCount": 1
39}
Model对象定义
Eni
参数名称 | 类型 | 描述 |
---|---|---|
eniId | String | 弹性网卡的ID |
name | String | 弹性网卡的名称 |
description | String | 弹性网卡的描述 |
regionId | String | 弹性网卡所属的节点 |
instanceId | String | 挂载的云主机ID |
macAddress | String | 网卡的mac地址 |
vpcId | String | 网卡所属的vpcId |
subnetId | String | 网卡所属的子网ID |
securityGroupIds | List<String> | 网卡关联的安全组ID集合 |
status | String | 网卡的状态: available:未挂载,inuse:已挂载, attaching:挂载中, detaching:卸载中 |
ipSet | List<PrivateIP> | 网卡的IP集合 |
PrivateIP
参数名称 | 类型 | 描述 |
---|---|---|
primary | boolean | 是否是主IP,true为主IP,false为辅助IP |
privateIpAddress | String | 内网IP地址 |