查询白名单
更新时间：2026-01-09
接口说明
当前v1版本接口仅可查询 default 白名单分组，其余自定义的白名单分组信息无法通过v1版本接口查询。如有需求请使用v2版本接口。
请求结构
Plain Text
1GET /v{version}/instance/{instanceId}/securityIp HTTP/1.1
2Host: rds.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无特殊其他头域。
请求参数
| 参数名称 | 参数类型 | 是否必须 | 参数位置 | 描述 | 示例值 |
|---|---|---|---|---|---|
| version | Integer | 是 | URL参数 | 1 | API 版本号，当前取值支持 1、2。取值为1时: 仅会获取默认白名单分组（default）的信息；取值为2时，则会获取当前实例所有白名单分组的信息。v2版本优化了接口校验幂等的方式，无需通过ETag值操作指定的白名单分组，因此v2版本接口不会返回Etag值 |
| instanceId | String | 是 | URL参数 | rdsglbn5wuhtk6g | 实例 ID |
返回头域
| 参数名称 | 参数类型 | 是否必须 | 示例值 | 描述 |
|---|---|---|---|---|
| x-bce-if-match | String | 是 | v1 | 通过查询接口获取到的ETag值 |
返回参数
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| etag | String | 数据修改的版本号，如："v0"。当前字段仅在 version 取值为1时返回 |
| securityIps | List<String> | 白名单IP地址列表 |
| securityIpGroup | String | 当前字段为保留字段，固定取值 console。仅在version 取值为2时返回 |
| tag | String | 白名单分组名称。仅在version 取值为2时返回 |
v1版本示例
请求示例
Plain Text
1GET /v1/instance/rds-5J8tqr3R1/securityIp HTTP/1.1
2HOST: rds.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
3Content-Type: application/json
4{
5 "etag":"v0",
6 "securityIps": ["%"]
7}v2版本示例
请求示例
Plain Text
1GET /v2/instance/rds-5J8tqr3R1/securityIp HTTP/1.1
2HOST: rds.bj.baidubce.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
3Content-Type: application/json
4{
5 "securityIps": [
6 {
7 "securityIpGroup": "console",
8 "securityIps": [
9 "192.168.1.5",
10 "%"
11 ],
12 "tag": "test1"
13 },
14 {
15 "securityIpGroup": "console",
16 "securityIps": [
17 "192.168.1.3"
18 ],
19 "tag": "test2"
20 },
21 {
22 "securityIpGroup": "console",
23 "securityIps": [
24 "192.168.2.11"
25 ],
26 "tag": "test44"
27 },
28 {
29 "securityIpGroup": "console",
30 "securityIps": [
31 "%"
32 ],
33 "tag": "default"
34 }
35 ]
36}