接口功能介绍
分页查询IP白名单。目前支持的白名单形式:
- 支持网段配置:如 10.142.90.0/24
- 支持通配:如 192.168.* .*
- 支持通配:如 192.168.0.1
接口约束
请先订购DRDS实例。
URI
GET /v2/ip/list-white
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
groupName | 是 | String | 分组名称 | 默认分组 | |
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | IP id | ||
ip | 是 | String | ip或网段 | 192.168.2.* | |
desc | 否 | String | 描述 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": [
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000372/groups/group_0000000429/whitelist/ip_0000000566",
"ip": "192.168.1.*",
"desc": "192网段"
}
]
}
状态码
请参考 状态码说明。