查询云端转码状态

更新时间不可用

查询云端转码任务的当前状态。

GET
https://api.sd-rtn.com/v1/projects/{appId}/rtsc/cloud-transcoder/tasks/{taskId}

Query 方法用于在创建云端转码任务后查询转码状态。

鉴权

Basic Auth

声网云端转码 RESTful API 仅支持 HTTPS 协议。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成 Base64 编码凭证,并填入请求头部的 Authorization 字段中。详见实现 HTTP 基本认证。

路径参数

taskIdstring
必填

转码任务 ID,为 UUID,用于标识本次请求操作的 Cloud transcoder。

appIdstring
必填

声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。

查询参数

builderTokenstring
必填

通过 Acquire 方法的响应包体得到的 tokenName 的值。

注意

请确保填入的 builderToken 和你在 Create 接口中传入的 builderToken 一致。

请求 Header

Content-Typestring
必填

application/json

响应

如果状态码为 2XX,则请求成功。

响应 Header

X-Request-IDstring

UUID(通用唯一识别码),用于标识本次请求。

注意:如果请求出错,请在日志中打印出该值,排查问题。如果本次请求的响应状态码不是 2XX,那么响应 Header 中可能无该字段。

响应 Body

字段
taskIdstring

转码任务 ID,为 UUID,用于标识本次请求操作的 Cloud transcoder。

createTsnumber

转码任务创建时的 Unix 时间戳(秒)。

statusstring

转码任务的运行状态:

  • "IDLE": 任务未开始。
  • "PREPARED": 任务已收到开启请求。
  • "STARTING": 任务正在开启。
  • "CREATED": 任务初始化完成。
  • "STARTED": 任务已经启动。
  • "IN_PROGRESS": 任务正在进行。
  • "STOPPING": 任务正在停止。
  • "STOPPED": 任务已经停止。
  • "EXIT": 任务正常退出。
  • "FAILURE_STOP": 任务异常退出。

注意:你可以用该字段监听任务的状态。

eventHandlersreserved-object

预留字段。

propertiesreserved-object

预留字段。

sequenceIdstring

预留字段。

variablesreserved-object

预留字段。

workflowsreserved-object

预留字段。

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/v1/projects/:appId/rtsc/cloud-transcoder/tasks/:taskId?builderToken=string" \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: <string>'

响应示例

{
  "createTs": 1661420011,
  "eventHandlers": {},
  "execution": {
    "workflows": {}
  },
  "properties": {},
  "sequenceId": "0",
  "services": {
    "cloudTranscoder": {
      "config": {},
      "createTs": 1661420011,
      "message": "OnSlaveServiceQueryUpdated",
      "serviceType": "cloudTranscoderV2",
      "status": "serviceInProgress"
    }
  },
  "status": "IN_PROGRESS",
  "taskId": "c0077139e34d0949c719189a393aa***",
  "variables": {},
  "workflows": {}
}