获取弹性公网IP列表
更新时间:2024-12-30
接口描述
本接口用来查询弹性公网IP(EIP)列表信息。
请求结构
JSON
1GET /v1/eip/list{?keyword,keywordType,order,orderBy,pageNo,pageSize,regionId,status,eipInstanceType,ipVersion,shareGroupId} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
pageNo | Integer | 否 | Query参数 | 页号,缺省值为1 |
pageSize | Integer | 否 | Query参数 | 查询返回每页个数,取值范围为1~100,缺省值为100 |
keywordType | String | 否 | Query参数 | 查询的关键字类型,取值为EIP_ID、 EIP_NAME、EIP_IP,分别表示弹性公网IP的ID、名称和IP地址 |
keyword | String | 否 | Query参数 | 查询的关键字值 |
regionId | String | 否 | Query参数 | 节点ID |
status | String | 否 | Query参数 | EIP 状态 |
eipInstanceType | String | 否 | Query参数 | eip实例类型 |
ipVersion | Integer | 否 | Query参数 | IP地址类型 |
shareGroupId | String | 否 | Query参数 | 带宽包ID |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
result | List<EipVo> | Eip列表数据 |
orderBy | String | 排序字段,缺省为createTime |
order | String | 排序顺序,取值为DESC、ASC,分别表示为降序、升序。缺省为DESC |
pageNo | Integer | 页码 |
pageSize | Integer | 每页结果数 |
totalCount | Integer | 结果总数 |
请求示例
JSON
1GET /v1/eip/list HTTP/1.1
2Host: bec.baidubce.com
3ContentType: application/json
4Authorization: authorization string
返回示例
JSON
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2021 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "result": [
9 {
10 "bandwidthInMbps": 10,
11 "city": "CHANGZHOU1",
12 "cityName": "常州1",
13 "createTime": "2024-12-27T08:16:52Z",
14 "eip": "61.160.222.103",
15 "eipId": "ip-eupghaap",
16 "eipInstanceType": "normal",
17 "instanceId": "",
18 "ipVersion": 4,
19 "isp": "ct",
20 "mode": "nat",
21 "name": "test",
22 "paymentTiming": "Postpaid",
23 "purpose": "public",
24 "region": "EAST_CHINA",
25 "regionId": "cn-changzhou1-ix",
26 "regionName": "华东",
27 "routeType": "ChinaTelcom",
28 "serviceProvider": "TRIPLE_LINE",
29 "serviceProviderName": "三线",
30 "shareGroupId": "",
31 "status": "available",
32 "tags": [
33 {
34 "tagKey": "默认项目",
35 "tagValue": ""
36 }
37 ]
38 }
39 ],
40 "orders": null,
41 "orderBy": "createTime",
42 "order": "desc",
43 "pageNo": 1,
44 "pageSize": 1000,
45 "totalCount": 1
46}
错误码
请参照错误返回章节的内容。
Model对象定义
EipVo
参数名称 | 类型 | 描述 |
---|---|---|
eipId | String | 弹性公网IP的ID |
name | String | 弹性公网IP名称 |
shareGroupId | String | 共享带宽组ID,若为普通EIP,此项值为空 |
eipInstanceType | String | EIP实例类型, normal 普通EIP类型; shared 共享带宽中的EIP |
eip | String | 弹性公网IP |
instanceId | String | eip绑定资源的id |
instanceType | String | eip绑定资源的类型 |
status | String | eip状态 |
bandwidthInMbps | int | eip带宽 |
routeType | String | 线路类型 |
createTime | String | 创建时间 |
paymentTiming | String | 付款时间,后支付(Postpaid) |
tags | List<TagModel> | 资源标签 |
regionId | String | 所属regionId |
ipVersion | int | IP地址类型 |
mode | String | 网络类型 |
instanceName | String | eip绑定资源的name |
instanceIp | String | eip绑定资源的ip |
isp | String | eip运营商 |
region | String | 节点所在region |
regionName | String | 节点所在region名称 |
city | String | 节点所在city |
cityName | String | 节点所在city名称 |
serviceProvider | String | 节点所属运营商 |
serviceProviderName | String | 节点所属运营商名称 |
instanceStatus | String | eip绑定资源的状态 |
TagModel
参数名称 | 类型 | 描述 |
---|---|---|
tagKey | String | 标签键 |
tagValue | String | 标签值 |