查看云端混流任务--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

查看云端混流任务

最近更新时间：2024.09.12 19:49:59首次发布时间：2024.06.24 10:59:27

调用 GetCloudMixTaskDetail 接口，查看云端混流任务详细信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=GetCloudMixTaskDetail&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetCloudMixTaskDetail`	接口名称。当前 API 的名称为 `GetCloudMixTaskDetail`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
TaskID	String	是	`086b7972234d7b71`	混流任务 ID，您可以通过 ListCloudMixTask 接口获取混流任务 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述

参数	类型	示例值	描述
Code	Integer	`0`	请求响应码，取值及含义如下。 `0`：请求成功； `500`：内部处理错误； `400`：请求异常。
Message	String	`success`	请求响应码对应的信息。
Data	Object of Data	`-`	返回的数据。

Code

Integer

0

请求响应码，取值及含义如下。

0：请求成功；
500：内部处理错误；
400：请求异常。

Message String success 请求响应码对应的信息。

Data Object of Data - 返回的数据。

Data

参数	类型	示例值	描述
LastOperationIndex	Integer	`1`	任务最近一次更新的版本标识。
LastSuccessOperationIndex	Integer	`1`	任务最近一次成功更新的版本标识。
Rule	String	`json string`	混流任务详细配置的 Json 字符串。
Status	String	`done`	混流任务状态，取值及含义如下所示。 `pending`：任务调度被阻塞。 `prepare`：正在准备任务资源。 `runing`：任务进行中。 `prestop`：正在清理任务资源。 `done`：任务已结束。
TaskID	String	`086b7972234d7b71`	混流任务 ID。

请求示例

POST https://live.volcengineapi.com?Action=GetCloudMixTaskDetail&Version=2023-01-01
{
    "TaskID": "086b7972234d7b71"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20240313150157EA83ECD053C51400A378",
        "Action": "GetCloudMixTaskDetail",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success",
        "Data": {
            "LastOperationIndex": 1,
            "LastSuccessOperationIndex": 1,
            "Rule": "json string",
            "Status": "done",
            "TaskID": "086b7972234d7b71"
        }
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。