ListTaskInstances - 列举任务实例概要信息--AI 数据湖服务-火山引擎

文档中心

导航

ListTaskInstances - 列举任务实例概要信息

最近更新时间：2025.12.01 17:36:07首次发布时间：2025.12.01 17:36:07

列举任务实例概要信息

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListTaskInstances	要执行的操作，取值：ListTaskInstances。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
SortBy	String	否	CreateTime	排序字段
TaskIds	Array of String	否	t-uuid1,t-uuid2	任务 Id 数组
OwnerIds	Array of Long	否	123,456	实例启动者 Id 列表
Statuses	Array of String	否	Created,Processing	任务实例状态数组, Created(已创建)/Submitting(提交中)/ResourceInitializing(启动中)/Processing(处理中)/Completed(已完成)/Cancelled(已取消)/Failed(运行失败)/SubmitFailed(提交失败)/AnalysisFailed(解析失败)
NextToken	String	否	nextToken	下一次查询起始Id（不包含）或页码（默认为0）
SortOrder	String	否	Desc	排序顺序
MaxResults	Integer	否	10	单页记录数
TriggerTypes	Array of String	否	Manual	触发方式, Manual(手动触发)/Cron(定时触发)/Workflow(工作流触发)
TaskInstanceIds	Array of String	否	ti-uuid1,ti-uuid2	实例 Id 数组

返回参数

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

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

请求示例

POST https://open.volcengineapi.com
{
    "SortBy": "CreateTime",
    "TaskIds": [
        "t-uuid1",
        "t-uuid2"
    ],
    "OwnerIds": [
        123,
        456
    ],
    "Statuses": [
        "Created",
        "Processing"
    ],
    "NextToken": "nextToken",
    "SortOrder": "Desc",
    "MaxResults": 10,
    "ClientToken": "uuid-xxxxxx",
    "TriggerTypes": [
        "Manual"
    ],
    "TaskInstanceIds": [
        "i-uuid1",
        "i-uuid2"
    ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025112517201724203411616584B748",
    "Action": "ListTaskInstances",
    "Version": "2025-08-15",
    "Service": "las_ai_qa",
    "Region": "cn-beijing"
  },
  "Result": {
    "Items": [
      {
        "Status": "Completed",
        "TaskId": "t-uuid",
        "OwnerId": 123456,
        "TaskType": "Daft",
        "AccountId": 123456,
        "OwnerName": "name",
        "CreateTime": "2025-01-01T01:01:01Z",
        "FinishTime": "2025-01-01T01:01:01Z",
        "RunOwnerId": 123456,
        "UpdateTime": "2025-01-01T01:01:01Z",
        "TriggerType": "Manual",
        "RunOwnerName": "name",
        "CancelOwnerId": 123456,
        "TaskInstanceId": "ti-uuid",
        "CancelOwnerName": "name",
        "StateChangeReason": "Failed reason"
      }
    ],
    "NextToken": "0",
    "MaxResults": 10,
    "TotalCount": 439
  }
}

错误码

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

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