最近更新时间:2022-02-24
调用视频云 openAPI 后返回数据采用统一格式,返回结果格式主要为 JSON 格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
RequestId | String | 是 | 全局唯一的请求ID |
Code | String | 否 | 错误码 |
Message | String | 否 | 错误描述 |
Data | Object | 否 | 结果数据 |
调用直播 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天 |
400 | InvalidTime.ValueNotSupported | Time period should less than 24 hours. | 时间范围不能超过24小时 |
400 | ParameterInvalid.Error | The specified parameter {parameter} is not valid. | 指定参数取值非法 |
400 | ParameterFormat.Error | The specified parameter {parameter} format error. | 指定参数格式不合法 |
500 | InvalidHLS | The Group needs to enable HLS. | 播放协议HLS,空间未开启HLS服务 |
500 | InternalServerError.Error | The request processing has failed due to some unknown error, exception or failure. | 发生未知错误 |