查询IP地址组列表
更新时间:2024-12-27
描述
查询IP地址组列表。
请求结构
Plain Text
1GET /v{version}/ipSet?ipVersion={ipVersion}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,目前取值为1 |
ipVersion | String | 否 | Query参数 | ipVersion,取值IPv4或IPv6 |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | Integer | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000,缺省值为1000 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
ipSets | List<IpSet> | IP地址组列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | Boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | Integer | 每页包含的最大数量 |
请求示例
Plain Text
1GET /v1/ipSet?ipVersion=IPv4&marker=ips-w2d4kgc3x0y1&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7e789a40-adac-414a-8bd4-916d6be61112
3Date: Mon, 02 Apr 2019 08:14:25 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "ipSets": [{
8 "ipSetId": "ips-w2d4kgc3x0y1",
9 "name": "test_ipSet",
10 "description": "",
11 "ipVersion": "IPv4",
12 "ipAddressInfo": [{
13 "ipAddress": "10.101.151.17",
14 "description": "ip address description"
15 }],
16 "bindedInstanceNum": 3
17 }],
18 "marker": "ips-w2d4kgc3x0y1",
19 "isTruncated": true,
20 "nextMarker": "ips-sd57mmq4irn7",
21 "maxKeys": 1
22}