查询共享带宽列表
更新时间:2025-01-02
接口描述
本接口用于查询共享带宽列表。
请求结构
JSON
1GET /v1/eipgroup?status={status}&ipVersion={ipVersion}®ionId={regionId}&pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
pageNo | Integer | 否 | Query参数 | 页号,缺省值为1 |
pageSize | Integer | 否 | Query参数 | 查询返回每页个数,取值范围为1~100,缺省值为100 |
keywordType | String | 否 | Query参数 | 查询实例的关键字类型,取值为EG_ID、EG_NAME |
keyword | String | 否 | Query参数 | 查询的关键字值 |
regionId | String | 否 | Query参数 | 节点ID。用于查询所属节点的资源 |
ipVersion | String | 否 | Query参数 | IP地址类型 |
status | String | 否 | Query参数 | 状态 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
result | List<EipGroupModel> | VPC列表数据 |
orderBy | String | 排序字段,缺省为createTime |
order | String | 排序顺序,取值为DESC、ASC,分别表示为降序、升序。缺省为DESC |
pageNo | Integer | 页码 |
pageSize | Integer | 每页结果数 |
totalCount | Integer | 结果总数 |
请求示例
JSON
1 GET /v1/eipgroup HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string
4
返回示例
JSON
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2022 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "order": "desc",
9 "orderBy": "createTime",
10 "orders": null,
11 "pageNo": 1,
12 "pageSize": 10,
13 "result": [
14 {
15 "bandwidthInMbps": 22,
16 "city": "CHANGZHOU1",
17 "cityName": "常州1",
18 "createTime": "2024-12-31T03:37:08Z",
19 "eips": [
20 {
21 "bandwidthInMbps": 22,
22 "createTime": "2024-12-31T08:58:07Z",
23 "eip": "61.160.222.116",
24 "eipId": "ip-gse0b7aa",
25 "eipInstanceType": "shared",
26 "instanceId": "",
27 "instanceIp": "",
28 "instanceType": "",
29 "ipVersion": 4,
30 "isp": "ct",
31 "mode": "nat",
32 "name": "ip-gse0b7aa",
33 "paymentTiming": "Postpaid",
34 "purpose": "public",
35 "regionId": "cn-changzhou1-ix",
36 "shareGroupId": "eg-kgmyswts"
37 }
38 ],
39 "id": "eg-kgmyswts",
40 "ipVersion": "ipv4",
41 "name": "test-1",
42 "region": "EAST_CHINA",
43 "regionId": "cn-changzhou1-ix",
44 "regionName": "华东",
45 "routeType": "ChinaTelcom",
46 "serviceProvider": "TRIPLE_LINE",
47 "serviceProviderName": "三线",
48 "status": "binded",
49 "tags": [
50 {
51 "tagKey": "默认项目",
52 "tagValue": ""
53 }
54 ]
55 },
56 {
57 "bandwidthInMbps": 20,
58 "city": "CHANGZHOU1",
59 "cityName": "常州1",
60 "createTime": "2024-12-26T19:38:57Z",
61 "eips": [
62 {
63 "bandwidthInMbps": 20,
64 "createTime": "2024-12-26T11:31:52Z",
65 "eip": "36.150.181.56",
66 "eipId": "ip-z8zyzxaa",
67 "eipInstanceType": "shared",
68 "instanceId": "eni-pxitblohekej",
69 "instanceIp": "172.21.61.136",
70 "instanceType": "eni",
71 "ipVersion": 4,
72 "isp": "cm",
73 "mode": "pt",
74 "name": "test",
75 "paymentTiming": "Postpaid",
76 "purpose": "public",
77 "regionId": "cn-changzhou1-ix",
78 "shareGroupId": "eg-xybijfm3",
79 "status": "binded"
80 }
81 ],
82 "id": "eg-xybijfm3",
83 "ipVersion": "ipv4",
84 "name": "test",
85 "region": "EAST_CHINA",
86 "regionId": "cn-changzhou1-ix",
87 "regionName": "华东",
88 "routeType": "ChinaMobile",
89 "serviceProvider": "TRIPLE_LINE",
90 "serviceProviderName": "三线",
91 "status": "binded",
92 "tags": [
93 {
94 "tagKey": "默认项目",
95 "tagValue": ""
96 }
97 ]
98 }
99 ],
100 "totalCount": 2
101}
## 错误码
请参照错误返回章节的内容。
Model对象定义
EipGroupModel
参数名称 | 类型 | 描述 |
---|---|---|
name | String | 共享带宽名称 |
status | String | 共享带宽状态 |
id | String | 共享带宽ID |
bandwidthInMbps | int | 共享带宽带宽值,单位为Mbps |
createTime | String | 创建时间 |
tags | List<TagModel> | 资源标签 |
eips | List<EipVo> | 共享带宽中的EIP信息 |
ipVersion | String | IP地址类型 |
routeType | String | 线路类型 |
regionId | String | 节点ID |
region | String | 节点所在region |
regionName | String | 节点所在region名称 |
city | String | 节点所在city |
cityName | String | 节点所在city名称 |
serviceProvider | String | 节点所属运营商 |
serviceProviderName | String | 节点所属运营商名称 |
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带宽 |
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运营商 |
instanceStatus | String | eip绑定资源的状态 |
TagModel
参数名称 | 类型 | 描述 |
---|---|---|
tagKey | String | 标签键 |
tagValue | String | 标签值 |