ListTasks - 获取任务列表--AI 数据湖服务-火山引擎

文档中心

AI 数据湖服务

任务管理

ListTasks - 获取任务列表

获取任务列表

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListTasks	要执行的操作，取值：ListTasks。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
SortBy	String	否	CreateTime	排序字段
TaskIds	Array of String	否	[ "taskId1", "taskId2" ]	任务 Id 数组
OwnerIds	Array of Long	否	[ 123, 456 ]	子账号(创建者) Id 列表
TaskName	String	否	taskName	任务名，模糊查找
NextToken	String	否	nextToken	下一次查询起始Id（不包含）或页码（默认为0）
SortOrder	String	否	Desc	排序顺序
TaskTypes	Array of String	否	[ "Daft", "Python" ]	任务类型数组
MaxResults	Integer	否	10	单页记录数
ClientToken	String	否	uuid-xxxxxx	客户端token

返回参数

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

参数	类型	示例值	描述
Items	Array of Object	参见下文数据结构章节	概要列表
NextToken	String	0	分页查询的下一页token
MaxResults	Integer	10	单次查询可返回的最大记录数
TotalCount	Long	100	总记录数

请求示例

POST https://open.volcengineapi.com
{
    "SortBy": "CreateTime",
    "TaskIds": [
        "taskId1",
        "taskId2"
    ],
    "OwnerIds": [
        123,
        456
    ],
    "TaskName": "taskName",
    "NextToken": "nextToken",
    "SortOrder": "Desc",
    "TaskTypes": [
        "Daft",
        "Python"
    ],
    "MaxResults": 10,
    "ClientToken": "uuid-xxxxxx"
}

返回示例

{
    "Result": {
        "Items": [
            {
                "Name": "test_name",
                "TaskId": "t-uuid",
                "OwnerId": 123456,
                "TaskType": "Daft",
                "AccountId": 123456,
                "OwnerName": "123456",
                "CreateTime": "2025-01-01T01:01:01Z",
                "UpdateTime": "2025-01-01T01:01:01Z",
                "Description": "for test"
            }
        ],
        "NextToken": "0",
        "MaxResults": 10,
        "TotalCount": 100
    },
    "ResponseMetadata": {
        "Action": "ListTasks",
        "Region": "cn-beijing",
        "Service": "las_ai_qa",
        "Version": "2025-08-15",
        "RequestId": "20230604110420****100232280022D31",
        "Deprecated": true
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter	The required parameter {} is missing.	缺少必需的参数 {}。
400	InvalidParameter	The specified parameter {} is invalid.	指定的参数 {} 无效。
400	DryRunOperation	The request is validated by a dryrun operation.	该请求通过 dryrun 操作进行验证。
400	InvalidRequestParam	Invalid request param {}, cause {}	非法请求参数 {}, 原因 {}
500	InternalError	The request has failed due to an unknown error.	由于未知错误，请求失败。

最近更新时间：2026.02.25 14:29:46

这个页面对您有帮助吗？

有用

无用

AI 数据湖服务

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码