查询接入点的终端节点白名单
更新时间 2026-01-14 09:09:06
最近更新时间: 2026-01-14 09:09:06
接口功能介绍
查询接入点的终端节点白名单
接口约束
无
URI
POST /v1/userEndpointControl/showEndpointWhitelist
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| applicationId | 是 | String | 接入点id | b2160c2c-9c70-4ca9-b808-0d186c97280d | |
| endpointId | 是 | String | 终端节点id | endpoint-wlp72qh2bd |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 取值范围：200 成功 | 200 | |
| message | String | 提示信息 | Success | |
| returnObj | Object | 返回数据结构体 | {} | result |
| error | String | 错误码 仅错误时返回 格式为{服务编码}.{错误编号} | KMS.0269 |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| enableWhitelist | Boolean | 是否开启白名单 | true | |
| ips | Array of Strings | ip列表 | ["1.1.1.1"] | |
| applicationId | String | 接入点id | b2160c2c-9c70-4ca9-b808-0d186c97280d |
请求示例
请求url
https://{host}/v1/userEndpointControl/showEndpointWhitelist请求头header
{
"regionid": "fecnjniakfkn2314ndekqldedcsadfg"
}请求体body
{
"endpointId": "endpoint-wlp72qh2bd",
"applicationId": "b2160c2c-9c70-4ca9-b808-0d186c97280d"
}响应示例
{
"statusCode": 200,
"message": "查询终端节点白名单成功",
"returnObj": {
"enableWhitelist": true,
"applicationId": "b2160c2c-9c70-4ca9-b808-0d186c97280d",
"ips": [
"1.1.1.1"
]
}
}状态码
请参考状态码章节
错误码
请参考错误码章节
