撥測點信息:查詢
更新時間 2024-09-25 16:20:53
最近更新時間: 2024-09-25 16:20:53
分享文章
一次性撥測
撥測點信息:查詢
接口功能介紹
調用此接口可查詢撥測點信息。
接口約束
無。
URI
GET /v4/monitor/query-detection-point
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼,參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述,一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| error | String | 錯誤碼,請求成功時,不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| detectionPointList | Array of Objects | 撥測點列表 | detectionPoint |
表 detectionPoint
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| pointID | String | 撥測點ID | 728662dd11ec810800155d307d52 | |
| name | String | 撥測點名稱 | north_China | |
| description | String | 撥測點描述 | 華北 | |
| status | Boolean | 當前是否可用 | true |
請求示例
請求url
/v4/monitor/query-detection-point
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"detectionPointList": [
{
"pointID": "728662dd11ec810800155d307d52",
"name": "north_China",
"description": "華北",
"status": true
},
{
"pointID": "910c3625d5f0ebe505d44d4f257d6a",
"name": "south_China",
"description": "華南",
"status": true
}
],
"totalCount": 1
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |