安全认证管理
1.查询黑白名单
接口功能介绍
获取网关实例的黑白名单配置信息
接口约束
无
URI
GET /cgw/v1/security/blackWhite/list
Accept: application/json
路径参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instId | 是 | String | 实例Id | 7a2828074ef6e32e041a2ef124b19e63 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | {} | BlackWhiteListVO |
message | String | 异常描述 | success |
表 BlackWhiteListVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
blacklist | Object | 黑名单列表,非空时启用状态看disable值;为空时不启用 | [“1.1.1.1”] | IpListConfig |
whitelist | Object | 白名单列表,非空时启用状态看disable值;为空时不启用 | [“2.2.2.2”] | IpListConfig |
表 IpListConfig
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
enable | Boolean | 是否启用, true:启用,false:停用 | false | |
ips | Array of Strings | 名单列表 | false | |
type | String | 类型,default为 IP | IP |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/security/blackWhite/list?instId=String
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": {
"type": "IP",
"blacklist": [
"12.13.14.15"
],
"enable": false
}
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。