文档中心 > 返回结果
返回结果

最近更新时间:2022-09-16

调用视频云 openAPI 后返回数据采用统一格式,返回结果格式主要为 JSON 格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

返回结果

名称类型是否必须描述
RequestId
String
全局唯一的请求ID
Code
String错误码
MessageString错误描述
DataObject结果数据


成功结果

调用直播 openAPI 后,如果返回的 HTTP 状态码为:200,代表调用成功。

示例


     "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",  
     "Data": {
         /* 返回结果数据 */
      }
}

错误结果

调用直播API 后,如果返回的 HTTP 状态码为:400、403或者500,代表调用失败,系统将不会返回结果数据。此时,返回的消息体中包含:具体的错误代码、错误信息、全局唯一的请求ID:RequestId。您可以通过错误码定位问题。

示例


    "RequestId":"B6B9F518-60F8-4D81-9242-1207B356754D", 
    "Code":"InvalidUser.NotFound", 
    "Message":"The specified user does not exist." 
}

响应码

Http Code

Code

Message

备注说明

200

0

Success

成功

404

ActionInvalid.Error

An exception occured parameter, Action not found.

Action参数不存在
400

RequiredParameter.Missing

Required parameter ${parameter} is missing.

参数缺失,必传参数未传入
400

InvalidStartTime.ValueNotSupported

StartTime must small than endTime.

开始时间需要小于结束时间
400

InvalidTime.ValueNotSupported

Time period should less than 31 day.

时间范围不能超过31天

400InvalidTime.ValueNotSupported

Time period should less than 24 hours.

时间范围不能超过24小时
400

ParameterInvalid.Error

The specified parameter  {parameter} is not valid.

指定参数取值非法
400ParameterFormat.ErrorThe specified parameter {parameter} format error.指定参数格式不合法
400

InvalidHLS

The Group needs to enable HLS.

播放协议HLS,空间未开启HLS服务
400InvalidDevice.NotFoundThe device does not exist in our records.设备不存在
400InvalidRecord.NotFoundThe record does not exist in our records.录像不存在
400InvalidPictureId.NotFoundThe PictureId does not exist in our records.抓拍图片ID不存在
400InvalidDeviceThe device has been disabled.设备已停用
400InvalidGroup.NotFoundThe group does not exist in our records.空间不存在
400InvalidGroupThe group has been disabled.空间已停用
400InvalidDevice.OfflineThe device is offline.设备不在线
400InvalidChannel.OfflineThe channel is offline.通道不在线
400InvalidDevice.ErrorAn error has occurred in the device.设备返回错误
400InvalidDevice.UnregisteredThe device is not registered.设备未注册
400InvalidTime.MalformedThe specified parameter StartTime and EndTime is not valid.时间参数不合法
400SipServer.Error

信令服务code:{err_code}, msg:{err_msg}

SIP服务错误
400TaskServer.Error任务调度服务code:{err_code}, msg:{err_msg}TaskServer服务错误
400

Invalid.Device.Protocol

The Device does not support local record.

设备不支持本地录像

400

InvalidTask.Status

This Task status is invalid.

本地上传任务状态非法

400MissingParameter.TaskIdThe TaskId should not be null.本地上传任务ID不能为空
400InvalidTask.NotFoundThe task does not exist in our records.本地上传任务不存在
400
CallbackEventFlagsFormat.Error
The specified parameter CallbackEventFlags is too long.空间回调事件长度超长
400CallbackStatus.Error

The specified parameter CallbackEventFlags must not start event when Callback is empty.

/

The specified parameter CallbackEventFlags must start event when Callback is not empty.

空间回调地址与回调事件状态错误
400CallbackConfig.ErrorThe specified parameter CallbackEventFlags and Callback must be empty or not empty at sametime.空间回调参数设置错误
400DeviceUserConfig.ErrorThe specified parameter UserName and Password must be empty or not empty at sametime.设备用户信息设置错误
500

InternalServerError.Error

The request processing has failed due to some unknown error, exception or failure.

发生未知错误