响应状态码

在调用云端录制 RESTful API 过程中，你可能收到如下 HTTP 状态码：

• 如果 HTTP 状态码为 200，则请求成功。

• 如果 HTTP 状态码不为 200，则请求失败。你可以根据对应的响应 Body 中可能出现的如下字段排查问题：

  • message
  • code 和 reason 例如，请求失败时，你可能收到如下响应：

JSON

# 401 Unauthorized
# 仅有 message
{
  "message": "Invalid authentication credentials"
}

JSON

# 400 Bad Request
# 仅有 code 和 reason
{
  "code": 2,
  "reason": "Acquire: invalid resourceExpiredHour value!"
}

本文介绍你在调用云端录制 API 过程中可能会收到的错误码及其含义。你可以根据文档进行问题定位和排障。

通用状态码

状态码	message 字段	错误说明	解决方法
400 Bad Request	JSON { "message": "appid is invalid" }	使用了非法的 App ID。	服务未开通，请先开通服务再调用 API。
401 Unauthorized	JSON { "message": "Unauthorized" }	Authorization 缺失。	没有进行 HTTP 基础认证。在调用 API 时请确保使用 HTTP 基础认证获取 Authorization 的值。
401 Unauthorized	JSON { "message": "Invalid authentication credentials" }	非法的 Authorization。	填入的 Authorization 非法。请检查： 客户 ID 和客户密钥是否正确 Authorization 生成算法是否正确 客户 ID 和客户密钥与 App ID 是否匹配
404 Not Found	JSON { "message": "no Route matched with those values" }	请求路由错误。	请检查发送请求的接口和 URL 是否正确
429 Too Many Requests	JSON { "message": "API rate limit exceeded" }	被限流了。	请求太快被限制，可以联系技术支持 申请提高 API 配额，或者稍后进行重试，同时检查集成避免过多的 API 调用。

API 调用返回状态码

Acquire

在调用 Acquire 后，响应中可能返回的状态码及报错信息入下：

状态码	code 和 reason 字段	错误说明	解决方法
400 Bad Request	JSON { "code": 2, "reason": "xxx" }	请求参数错误。	请求 Header、接口、URL 或请求 Body 错误，请检查集成。具体原因可以参考 reason 字段的内容。
400 Bad Request	JSON { "code": 400, "reason": "invalid_appid" }	使用了非法的 App ID。	服务未开通，请先开通服务再调用 API。
400 Bad Request	JSON { "code": 401, "reason": "invalid_channel_name" }	使用了非法的频道名。	请求 Body 中的 cname 字段包含非字符，请检查集成。cname 支持的字符集可以参考 RTC 频道名的参数填写。
400 Bad Request	JSON { "code": 405, "reason": "no_active_status" }	App 状态异常。	App 服务异常，可能是由于欠费停机，请自行检查。
400 Bad Request	JSON { "code": 406, "reason": "vendor_over_load" }	配额受限。	并发任务数量限制，可以联系技术支持 申请提高 API 配额，或者稍后进行重试，同时检查集成避免任务泄漏。
500 Internal Server Error	JSON { "code": 500, "reason": "internal_error" }	内部错误。	服务端错误，进行退避重试。
500 Internal Server Error	JSON { "code": 501, "reason": "no_worker_manager_available" }	无资源可用。	服务端错误，进行退避重试。
500 Internal Server Error	JSON { "code": 504, "reason": "allocate_timeout" }	请求超时。	服务端错误，进行退避重试。

Start

在调用 Start 后，响应中可能返回的状态码及报错信息入下：

状态码	code 和 reason 字段	错误说明	解决方法
201 Created	JSON { "code": 7, "reason": "already started" }	任务已经启动了，重复调用 Start 方法。
206 Partial Content	JSON { "code": 65, "reason": "request not completed" }	请求未完成。	请求已发送到后端，但是响应超时，建议进行重试。\n如果重试失败，建议重新调用 Acquire + Start 启动另外一路任务。
400 Bad Request	JSON { "code": 2, "reason": "xxx" }	请求参数错误。	请求 Header、接口、URL 或请求 Body 错误，请检查集成。具体原因可以参考 reason 字段的内容。
400 Bad Request	JSON { "code": 53, "reason": "task conflict" }	重复启动，已经存在相同的 cname + uid 的任务。	检查集成避免该问题，或者更换 cname + uid 重新调用 Acquire + Start 启动任务。
500 Internal Server Error	JSON { "code": 502, "reason": "Failed to allocate worker" }	无资源可用。	建议重新调用 Acquire + Start 启动另外一路任务。
500 Internal Server Error	JSON { "code": 62, "reason": "request timeout" }	请求超时。	后端服务暂时不可用，建议进行重试。\n如果重试失败，建议重新调用 Acquire + Start 启动另外一路任务。

Update

在调用 Update 后，响应中可能返回的状态码及报错信息入下：

状态码	code 和 reason 字段	错误说明	解决方法
206 Partial Content	JSON { "code": 65, "reason": "request not completed" }	请求未完成。	请求已发送到后端，但是响应超时，建议进行重试。
400 Bad Request	JSON { "code": 2, "reason": "xxx" }	请求参数错误。	请求 Header、接口、URL 或请求 Body 错误，请检查集成。具体原因可以参考 reason 字段的内容。
404 Not Found	JSON { "code": 404, "reason": "failed to find worker" }	任务不存在。	任务不存在，可能是任务已经退出，请结合自身业务逻辑判断是否需要处理。
504 Gateway Timeout	JSON { "code": 62, "reason": "request timeout" }	请求超时。	后端服务暂时不可用，建议进行重试。

UpdateLayout

在调用 UpdateLayout 后，响应中可能返回的状态码及报错信息入下：

状态码	code 和 reason 字段	错误说明	解决方法
206 Partial Content	JSON { "code": 65, "reason": "request not completed" }	请求未完成。	请求已发送到后端，但是响应超时，建议进行重试。
400 Bad Request	JSON { "code": 2, "reason": "xxx" }	请求参数错误。	请求 Header、接口、URL 或请求 Body 错误，请检查集成。具体原因可以参考 reason 字段的内容。
404 Not Found	JSON { "code": 404, "reason": "failed to find worker" }	任务不存在。	任务不存在，可能是任务已经退出，请结合自身业务逻辑判断是否需要处理。
504 Gateway Timeout	JSON { "code": 62, "reason": "request timeout" }	请求超时。	后端服务暂时不可用，建议进行重试。

Query

在调用 Query 后，响应中可能返回的状态码及报错信息入下：

状态码	code 和 reason 字段	错误说明	解决方法
206 Partial Content	JSON { "code": 65, "reason": "request not completed" }	请求未完成。	请求已发送到后端，但是响应超时，建议进行重试。
400 Bad Request	JSON { "code": 2, "reason": "xxx" }	请求参数错误。	请求 Header、接口、URL 或请求 Body 错误，请检查集成。具体原因可以参考 reason 字段的内容。
404 Not Found	JSON { "code": 404, "reason": "failed to find worker" }	任务不存在。	任务不存在，可能是任务已经退出，请结合自身业务逻辑判断是否需要处理。
504 Gateway Timeout	JSON { "code": 62, "reason": "request timeout" }	请求超时。	后端服务暂时不可用，建议进行重试。

Stop

在调用 Stop 后，响应中可能返回的状态码及报错信息入下：

状态码	code 和 reason 字段	错误说明	解决方法
206 Partial Content	JSON { "code": 65, "reason": "request not completed" }	请求未完成。	请求已发送到后端，但是响应超时，建议进行重试。
206 Partial Content	JSON { "code": 435, "reason": "no recorded data" }	没有录制文件生成。	频道内没有用户发流，没有生成录制文件，请检查是否符合业务逻辑。
400 Bad Request	JSON { "code": 2, "reason": "xxx" }	请求参数错误。	请求 Header、接口、URL 或请求 Body 错误，请检查集成。具体原因可以参考 reason 字段的内容。
400 Bad Request	JSON { "code": 49, "reason": "invalid operation" }	非法操作。	任务正在退出，不能进行当前操作，可能是重复调用 Stop 或者其他原因导致任务正在退出。常见的有录制机器人被剔出房间，或者没有用户发流触发 maxIdleTime 逻辑自动停止任务。
404 Not Found	JSON { "code": 404, "reason": "failed to find worker" }	任务不存在。	任务不存在，可能是任务已经退出，请结合自身业务逻辑判断是否需要处理。
504 Gateway Timeout	JSON { "code": 62, "reason": "request timeout" }	请求超时。	后端服务暂时不可用，建议进行重试。