查詢接入點的終端節點白名單
更新時間 2025-01-09 14:04:14
最近更新時間: 2025-01-09 14:04:14
分享文章
接口功能介紹
查詢接入點的終端節點白名單
接口約束
無
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
//{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"
]
}
}狀態碼
請參考狀態碼章節
錯誤碼
請參考錯誤碼章節
