查詢回調規則列表
更新時間 2024-09-11 16:11:35
最近更新時間: 2024-09-11 16:11:35
分享文章
接口功能介紹
本接口用于查詢回調規則列表，即查詢回調模板綁定的設備列表。
接口約束
查詢模板前確保存在該回調模板。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/callbackTemplate/*/callbackRule
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| TemplateId | 是 | String | 模板ID。 | 739943519892963328 |
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| SortBy | 否 | String | 選擇按一個字段排序，默認為DeviceId，按照設備id排序。取值：DeviceId(設備id)，CreatedTime(創建時間)，UpdatedTime(更新時間)。 | CreatedTime | |
| SortDirection | 否 | String | 排序方式，默認升序。取值：asc(升序)，desc(降序)。 | asc | |
| PageNum | 否 | Integer | 第幾個分頁，默認為1。 | 1 | |
| PageSize | 否 | Integer | 分頁大小，默認為20，取值范圍為1～1000。 | 20 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| PageNum | Integer | 第幾個分頁。 | 1 | |
| PageSize | Integer | 分頁大小。 | 10 | |
| TotalPage | Integer | 分頁總數。 | 1 | |
| TotalNum | Integer | 回調規則總數。 | 10 | |
| CallbackRules | Array of Objects | 回調規則列表。 | CallbackRule | |
| RequestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b |
表 CallbackRule
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| TemplateId | Integer | 模板ID。 | 739943519892963328 | |
| DeviceId | String | 設備ID。 | 700576974938832896 | |
| DeviceName | String | 設備名稱。 | 回調測試 | |
| CreatedTime | String | 回調規則創建時間。 | 1691995152 | |
| UpdatedTime | String | 回調規則更新時間。 | 1691995152 |
枚舉參數
無
請求示例
請求url
GET '/v2/callbackTemplate/739943519892963328/callbackRule'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "6d84fd1808ac4bb78a7f87f43ec06518","returnObj": {"PageNum": 1,"PageSize": 20,"TotalPage": 1,"TotalNum": 1,"CallbackRules": [{"TemplateId": "739943519892963328","DeviceId": "700576974938832896","DeviceName": "回調測試","CreateTime": "1691995152","UpdateTime": "1691995152"}],"RequestId": "6d84fd1808ac4bb78a7f87f43ec06518"}}
狀態碼
請參考
錯誤碼
請參考
