接口功能介绍 本接口用于修改回调模板。 接口约束 1. 修改模板前确保存在该回调模板。 2. url会进行批量修改，未传参的url将被置空。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/callbackTemplate/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateId 是 String 模板ID。 739943519892963328 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 Description 否 String 模板描述，长度小于等于256个字符。 回调模板 CallbackKey 是 String 回调Key。 abc123 DeviceStatusNotifyUrl 否 String 设备状态回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < StreamStatusNotifyUrl 否 String 流状态回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < RecordNotifyUrl 否 String 录制回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < AiEventNotifyUrl 否 String AI回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 <

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 SortBy 否 String 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：CreatedTime：创建时间；UpdatedTime：更新时间； CreatedTime SortDirection 否 String 排序方式，默认升序。取值：asc：升序；desc：降序。 asc PageNum 否 Integer 第几个分页，默认为1。 1 PageSize 否 Integer 分页大小，默认为20，取值范围为1～1000。 20

参数 参数类型 说明 示例 下级对象 Region String 设备接入区域。 0851002 InNetworkType String 接入网络类型，默认public。取值：public：互联网；private：专线网络。 public OutNetworkType String 播放网络类型，默认public。取值：public：互联网；private：专线网络。 public Device Object 设备信息。 Device VideoDevice Object 视频协议设备信息。 VideoDevice ViidDevice Object 视图协议设备信息。 ViidDevice CreatedTime String 设备创建时间。 1685515845343 UpdatedTime String 设备更新时间。 1685516000079 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b 表 Device

参数 是否必填 参数类型 说明 示例 下级对象 RecordTemplateId 是 String 模板id 717074786139029504

参数 参数类型 说明 示例 下级对象 ChannelSize Integer 通道数量。 1 MaxChannelSize Integer 最大通道数量。 1 OnlineChannels Integer 在线通道数量。 1 OfflineChannels Integer 离线通道数量。 0 OnlineStreams Integer 在线流数量。 1 OfflineStreams Integer 离线流数量。 0 FailedStreams Integer 失败流数量。 0 表 Industry

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

枚举参数 无 请求示例 请求url GET '/v2/gb28181Certs?PageNum1&PageSize20' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "bed9f443d64e4361ad272860d4ab67ca","returnObj": {"PageNum": 1,"PageSize": 20,"TotalPage": 1,"TotalNum": 1,"gb28181Certs": [{"UserName": "test","UserType": "normal","Description": "","CreatedTime": "20220922093159","UpdatedTime": "20221021150614"}],"RequestId": "bed9f443d64e4361ad272860d4ab67ca"}} 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url PUT '/v2/devices/32388487739092996/records/stopCloudRecord' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "716580ae4fe14821b9cfdad0066c2649","returnObj": {"CreatedTime": "20230506 15:29:18","UpdatedTime": "20230506 16:02:34","RequestId": "716580ae4fe14821b9cfdad0066c2649"}} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 本接口用于创建GB28181凭证，该凭证用于GB28181设备注册。 接口约束 创建的凭证名称请勿重复。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/gb28181Certs 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名，长度164位，仅支持输入小写字母和数字。 cert Password 是 String 凭证密码，凭证密码长度为8位～32位的字符串，至少包含以下三种字符：大写字母、小写字母、数字和特殊字符（@ ）。 qwER1234 Description 否 String 凭证描述。 cert 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 UserName String 凭证用户名。 cert UserType String 凭证类型。 normal Description String 凭证描述。 描述 CreatedTime String 凭证创建时间。 1681370054428110 UpdatedTime String 凭证更新时间。 1681370054428110 RequestId String 请求ID。 64c9f09a7d434519abbcdd5e20620732

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert

参数 参数类型 说明 示例 下级对象 DeviceId String 设备ID。 752657499261403136 RequestId String 请求ID。 20be6a0c4b0f42a288fb563c561d0a4c

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 717793119419891712 RecordTemplateId 是 String 录制模板ID。 717074786139029504

接口功能介绍 本接口用于绑定视频存储模板至设备。 接口约束 仅设备的计费模式为按需时，可以手动绑定存储模板至设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/devices//recordTemplate/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 717793119419891712 RecordTemplateId 是 String 录制模板ID，如果已经绑定过录制模板则会覆盖旧的录制模板。 717074786139029504 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 CreatedTime String 绑定关系创建时间。 20230426 15:02:37 UpdatedTime String 绑定关系更新时间。 20230426 15:02:37 RequestId String 请求ID。 7069f32f16034c3e95988c0c30c04762

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 参数类型 说明 示例 下级对象 PageNum Integer 第几个分页。 1 PageSize Integer 分页大小。 10 TotalPage Integer 分页总数。 1 TotalNum Integer 模板总数。 10 CallbackTemplates Array of Objects 模板列表。 CallbackTemplate RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 68561b784a2944a7a713186f5cb20d34

接口功能介绍 本接口用于创建视频存储模板，支持配置录制类型、存储时长等。 接口约束 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/recordTemplates 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateName 是 String 模板名称，464位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格。 存储模板 FileFormat 否 String 录像文件格式，默认m3u8。取值：m3u8：符合hls协议的m3u8文件；ps：符合国标协议的ps文件。 m3u8 FileDuration 否 Integer 录像单文件时长，单位秒。 1800 RecordModes 是 Array of Objects 录制方式列表，可以配置多种录制类型。 RecordMode Description 否 String 模板描述，长度小于等于255个字符。 描述 表 RecordMode 参数 是否必填 参数类型 说明 示例 下级对象 RecordType 是 Integer 录制类型。取值：1：全天录制；2：循环定时录制；3：指定时间录制；5：手动录制。 1 StorageTime 是 Integer 存储时长，单位秒，最小不少于30天。例：2592000表示30天。 2592000 WeekTimeSections 否 Array of Objects 定时录制的时间段，当RecordType为2时，该字段必选。 WeekTimeSection SpecTimeSections 否 Array of Objects 指定时间录制的时间段，当RecordType为3时，该字段必选。 SpecTimeSection 表 WeekTimeSection 参数 是否必填 参数类型 说明 示例 下级对象 DayofWeek 是 Integer 日期。取值：1~~7（对应周一~~周日）。 1 StartTime 是 String 录制开始时间，格式：HH:mm:ss，范围：[00:00:00~23:59:59]。 00:02:00 EndTime 是 String 录制结束时间，格式：HH:mm:ss，范围：[00:00:00~23:59:59]。 00:05:00 表 SpecTimeSection 参数 是否必填 参数类型 说明 示例 下级对象 StartTime 是 String 录制开始时间，格式：YYYYDDMM HH:mm:ss。 20211125 00:02:00 EndTime 是 String 录制结束时间，格式：YYYYDDMM HH:mm:ss。 20211126 00:05:00

构造请求 本节介绍REST API请求的组成，以调用云主机产品的"根据regionID查询用户资源"举例说明如何调用该API。 请求示例 POST ContentType:application/json ctyuneoprequestid:0ffb9b07d5a84e19b3ce12dfb9705a1d EopAuthorization:4a4bdc57e06542199b5f98d4cd107be2 Headersctyuneoprequestid;eopdate Signatureb2WEo4nh9ewn6SWOP0ii5g8L0z9CT5gprpDWntlCX9I Eopdate:20221107T093029Z 请求URI {URIscheme}://{Endpoint}/{resourcepath}?{querystring} 参数 描述 URIscheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。例如云主机产品服务在某个区域的Endpoint为“ctecsxxx.ctapi.ctyun.cn” resourcepath 资源路径，即API访问路径。从具体API的URI模块获取，例如"根据regionID查询用户资源"API的resourcepath为“/v4/region/customerResources” querystring 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名参数取值”，例如“?limit10”，表示查询不超过10条数据 示例： 云主机根据regionID查询用户资源，则需使用云主机产品在对应区域的Endpoint（ctecsxxx.ctapi.ctyun.cn），并在"根据regionID查询用户资源"的URI部分找到resourcepath（/v4/region/customerResources），拼接起来如下所示。 < 说明： 为方便查看，在每个具体API的URI部分，只给出resourcepath部分，并将请求方法写在一起。这是因为URIscheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。 {resourcepath}资源路径，使用编码的规范URI示例： 前： /v4/region/customerResources api/code 后： /v4/region/customerResources%20api/code 说明： 资源路径{resourcepath}是从HTTP Host结束到查询字符串参数（如果有）的问号字符（“?”）中间的部分。 需要根据RFC 3986标准化URI路径规范移除冗余和相对路径部分。路径中每个部分都必须进行URI编码。 {querystring}查询参数，使用规范查询字符串示例： 前： prodInstId11&startTime20210404T06:01:46Z 后： prodInstId11&startTime20210404T06%3A01%3A46Z 说明： {querystring}为键值对，使用等号字符()拼接。值需进行URI编码，同样需要满足RFC 3986关于URL编码规范的定义要求。键则不需要。对没有值的参数使用空字符串。 在每个参数值后追加与字符(&)，列表中最后一个值除外。 使用 %XY 对所有其他字符进行百分比编码，其中“X”和“Y”为十六进制字符（09和大写字母AF）。例如，空格字符必须编码为 %20（不像某些编码方案那样使用“+”)，扩展UTF8字符必须采用格式 %XY%ZA%BC。 RFC 3986规范的具体要求： 字符AZ、az、09 以及字符、、.、不编码。 对其它ASCII码字符进行编码。编码格式为%加上16进制的ASCII码。例如半角双引号（"）将被编码为%22。空格编码成%20，而不是加号（+）。 非ASCII码通过UTF8编码。

认证鉴权 获取天翼云AK/SK: 1. 点击天翼云门户首页右上角的“登录”，输入登录的用户名和密码。 2. 点击右上角的“我的”， 点击个人中心。 3. 在左侧下拉列表中单击“安全设置”。 4. 在安全设置页面的“用户AccessKey”列，点击“新建”按钮，获取访问密钥（AK/SK）。新建成功后，“新建”按钮变为“查看”，您可以点击并查看并复制AK/SK。 认证鉴权介绍： AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 参数 描述 AK（Access Key ID） 访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名 SK（Secret Access Key） 私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 说明： 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应示例 {"statusCode": 200,"message": "请求成功","requestId": "f10722935d7e48feaf9d84d65c93ddd2","returnObj": {"RequestId": "f10722935d7e48feaf9d84d65c93ddd2"}} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996

接口功能介绍 本接口用于删除目录。 接口约束 删除目录前确保存在该目录。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI DELETE /v2/dirs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 897098424844288 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 8ce18739d4e34d51ab260fc551228a5c 枚举参数 无 请求示例 请求url DELETE '/v2/dirs/700835918517108736' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "8ce18739d4e34d51ab260fc551228a5c","returnObj": {"RequestId": "8ce18739d4e34d51ab260fc551228a5c"}}

参数 是否必填 参数类型 说明 示例 下级对象 DirName 是 String 目录名称，长度不超过64个字符。 openapidir Description 否 String 目录描述，长度不超过255个字符。 description

枚举参数 无 请求示例 请求url GET '/v2/callbackTemplate/739943519892963328' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "aac5a1a85bf94d6a904139e1dc1d19ab","returnObj": {"TemplateId": "739943519892963328","TemplateName": "设备状态回调模板","Description": "","CallbackKey": "123","DeviceStatusNotifyUrl": " "","RecordNotifyUrl": "","AiEventNotifyUrl": "","CreateTime": "1691992586","UpdateTime": "1691992586","RequestId": "aac5a1a85bf94d6a904139e1dc1d19ab"}} 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 ParentDirId 否 String 上级目录ID。 29941936081076293 DirName 是 String 目录名称，长度不能超过64个字符。 openapidir Description 否 String 目录描述.长度不能超过255个字符。 description

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996