查询回调规则列表

最近更新时间:2026-03-19 18:16:28

天翼云智能视图服务API

1.查询回调规则列表

接口功能介绍

本接口用于查询回调规则列表,即查询回调模板绑定的设备列表。

接口约束

URI

GET /callbackTemplate/{TemplateId}/callbackRule

路径参数

参数是否必填参数类型说明示例下级对象
TemplateIdString模板ID。739943519892963328

Query参数

参数是否必填参数类型说明示例下级对象
SortByString选择按一个字段排序,默认为DeviceId,按照设备id排序。取值:DeviceId(设备id),CreatedTime(创建时间),UpdatedTime(更新时间)。CreatedTime
SortDirectionString排序方式,默认升序。取值:asc(升序),desc(降序)。asc
PageNumInteger第几个分页,默认为1。1
PageSizeInteger分页大小,默认为20,取值范围为1~1000。20

请求参数

请求头header参数

参数是否必填参数类型说明示例下级对象
AuthorizationString认证信息。CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f
Content-TypeString互联网媒体类型。application/json;charset=utf-8
HostString主机。vssapi.ctyun.cn
VersionString版本。2021-11-25
TimestampString时间戳。1689643309

请求体body参数

响应参数

参数参数类型说明示例下级对象
statusCodeInteger响应状态码。200
errorString错误码,执行成功时,不返回该字段。VSS_0001
messageString响应信息。请求成功
requestIdString请求ID。362d4e78556b47129182d0881fade86b
returnObjObject响应数据,执行失败时,不返回该字段。returnObj

表 returnObj

参数参数类型说明示例下级对象
PageNumInteger第几个分页。1
PageSizeInteger分页大小。10
TotalPageInteger分页总数。1
TotalNumInteger回调规则总数。10
CallbackRulesArray of Objects回调规则列表。CallbackRule
RequestIdString请求ID。362d4e78556b47129182d0881fade86b

表 CallbackRule

参数参数类型说明示例下级对象
TemplateIdInteger模板ID。739943519892963328
DeviceIdString设备ID。700576974938832896
DeviceNameString设备名称。回调测试
CreatedTimeString回调规则创建时间。1691995152
UpdatedTimeString回调规则更新时间。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"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。