DeleteCarouselTask - 删除轮播任务--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

DeleteCarouselTask - 删除轮播任务

最近更新时间：2025.04.09 11:15:30首次发布时间：2025.04.03 18:21:33

调用 DeleteCarouselTask 接口删除指定的轮播任务，任务删除后，系统将停止播放该任务的所有轮播内容并释放相关资源。

注意事项

不可恢复：调用 DeleteCarouselTask 接口后，任务及其相关资源将被释放，无法恢复，请谨慎操作。
立即停止：任务删除后，所有正在进行的轮播播放将立即终止，不会等待当前播放完成。
请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
TaskID	String	是	`44c5da50318440*********2d62c910b8`	待删除的轮播任务 ID，任务的唯一标识。调用 `CreateCarouselTask` 接口创建轮播任务时返回。

返回参数

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

参数	类型	示例值	描述
Data	String	`kill task [e1fb009334fc5b16] success,mesos id is [live_boe_bff26015_000000000025852],rowsAffect [0]`	删除任务的操作结果信息，返回任务是否成功删除以及相关的 Mesos ID 和操作影响记录数。

请求示例

POST https://live.volcengineapi.com?Action=DeleteCarouselTask&Version=2023-01-01
{
    "TaskID": "32b7435e2aa903cd"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202410301524025B4509E7E242BD12477C",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DeleteCarouselTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": "kill task [32b7435e2aa903cd] success,mesos id is [live_bff26015_000000000025852],rowsAffect [0]"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。