探測節點：查詢詳情
更新時間(jian) 2023-07-19 11:41:06
最(zui)近更(geng)新時間: 2023-07-19 11:41:06
分享文章(zhang)
接口功能介紹
調用此接口(kou)可查看(kan)探測節點的配(pei)置詳情。
接口約束
資源池ID，探(tan)測節點名稱不能為空。
URI
GET /v4/monitor/describe-probe-point
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| name | String | 是 | NeiMeng | 探測節點名稱 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表(biao)returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| mongoID | String | 數據庫ID | 635a4a3869bdc841ab0495dd | |
| ID | String | 探測節點唯一ID | 1 | |
| name | String | 探測節點名稱 | NeiMeng | |
| hermesRegion | String | region名稱 | neimengaz_03 | |
| position | String | 探測節點區域 | 內蒙 | |
| status | Boolean | 探測節點是否可用 | true |
請求示例
GET /v4/monitor/describe-site-monitor?regionID=81f7728662dd11ec810800155d307d5b&name=NeiMeng
響應示例
{
"statusCode":800,
"returnObj":{
"mongoID":"635a4a3869bdc841ab0495dd",
"ID":"1",
"name":"NeiMeng",
"hermesRegion":"neimengaz_03",
"position":"內蒙",
"status":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.ProbePointNotAvailable | 探測點不可用 |
| 其他 | 參見公共錯誤碼說明 |
