查询回调规则列表
最近更新时间:2026-03-19 18:16:28
天翼云智能视图服务API
1.查询回调规则列表
接口功能介绍
本接口用于查询回调规则列表,即查询回调模板绑定的设备列表。
接口约束
无
URI
GET /callbackTemplate/{TemplateId}/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参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Authorization | 是 | String | 认证信息。 | CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f | |
| Content-Type | 是 | String | 互联网媒体类型。 | application/json;charset=utf-8 | |
| Host | 是 | String | 主机。 | vssapi.ctyun.cn | |
| Version | 是 | String | 版本。 | 2021-11-25 | |
| Timestamp | 是 | String | 时间戳。 | 1689643309 |
请求体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 '/callbackTemplate/739943519892963328/callbackRule'
请求头header
{
"Authorization": "CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-08-14/vss, SignedHeaders=content-type;host;timestamp, Signature=eb8a1e1f14a6858b320cc40bc05142aea68bcca8cb967ddc227c0e8f59258dd4",
"Content-Type": "application/json;charset=utf-8",
"Host": "vssapi.ctyun.cn",
"Version": "2021-11-25",
"Timestamp": "1691995992"
}
请求体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"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录: