SearchSpeechTask - 搜索声影同传任务--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

SearchSpeechTask - 搜索声影同传任务

最近更新时间：2025.12.09 16:52:33首次发布时间：2025.12.09 16:52:33

调用 SearchSpeechTask 接口，搜索符合条件的声影同传任务。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
TaskStatus	Array of String	否	`["running", "init"]`	任务状态。默认返回所有状态的任务。取值如下： `running`：运行中。 `done`：已结束。 `prestop`：关闭中。 `init`：准备中。 `prepare`：启动中。
Name	String	否	`TaskA`	任务名称。默认返回所有任务。长度为 1-64 个字节。不支持模糊搜索，英文区分大小写。可包含以下字符：数字（0-9）大写字母（A-Z）小写字母（a-z）中文下划线（_）中划线（-）
CreateTimeSt	String	否	`2025-11-13T17:01:06+08:00`	返回创建时间在该时间点及之后的任务。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。默认返回所有任务。
CreateTimeEd	String	否	`2025-11-13T17:02:06+08:00`	返回创建时间在该时间点及之前的任务。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。默认返回所有任务。
Page	Integer	是	`1`	分页查询页码。取值为正整数。
PageSize	Integer	是	`10`	分页查询数量。取值大于 `0`。

返回参数

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

参数	类型	示例值	描述
Code	Integer	`0`	状态码。
Message	String	`success`	状态信息。
Data	Object of Data	`-`	任务数据。

Data

参数	类型	示例值	描述
Count	Integer	`1`	返回的任务总数。
Tasks	Array of Tasks	`-`	任务信息。

Tasks

参数	类型	示例值	描述
Name	String	`TaskA`	任务名称。
Status	String	`done`	任务状态。取值如下： `running`：运行中。 `done`：已结束。 `prestop`：关闭中。 `init`：准备中。 `prepare`：启动中。
TaskID	String	`b71c61****24ae4f`	任务 ID。
CreatedAt	String	`2025-11-14T15:34:43+08:00`	任务开始时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
UpdatedAt	String	`2025-11-14T16:50:53+08:00`	任务更新时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
StoppedAt	String	`2025-11-14T16:50:49+08:00`	任务结束时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。

请求示例

POST https://live.volcengineapi.com?Action=SearchSpeechTask&Version=2023-01-01
{
    "TaskStatus": [
        "running",
        "init"
    ],
    "Name": "TaskA",
    "CreateTimeSt": "2025-11-13T17:01:06+08:00",
    "CreateTimeEd": "2025-11-13T17:02:06+08:00",
    "Page": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "2025111417350416C47E772ECEBC01847B",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "SearchSpeechTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success",
        "Data": {
            "Count": 1,
            "Tasks": [
                {
                    "Name": "TaskA",
                    "Status": "done",
                    "TaskID": "b71c61****24ae4f",
                    "CreatedAt": "2025-11-14T15:34:43+08:00",
                    "UpdatedAt": "2025-11-14T16:50:53+08:00",
                    "StoppedAt": "2025-11-14T16:50:49+08:00"
                }
            ]
        }
    }
}

错误码

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