Sign In

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

PRODUCTS

OceanBase Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase Database

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Document Feedback

Task return structure

Last Updated：2026-04-03 03:16:02 Updated

share

share

Data structure of TaskInstance

Parameter	Type	Description
id	Long	The ID of the task.
name	String	The name of the task.
clusterId	Long	The ID of the cluster.
tenantId	Long	The ID of the tenant.
hostId	Long	The ID of the host.
type	String	The type of the task. Valid values: MANUAL: indicates a manually initiated task. SYS_ONECE: indicates a one-time task executed by the system. SCHEDULED: indicates a non-built-in scheduled task. SYS_SCHEDULED: indicates a built-in scheduled task.
status	String	The status of the task. Valid values: RUNNING FAILED SUCCESSFUL
creator	String	The username of the task creator.
operation	String	The operation performed by the task. Valid values: EXECUTE RETRY ROLLBACK SKIP CANCEL
executor	String	The IP address of the node that executed the task.
context	String	The execution context of the task, in JSON format.
createTime	String	The time when the task was created.
startTime	String	The start time of the task.
finishTime	String	The end time of the task.
prohibitRollback	Boolean	Indicates whether rollback was supported by the task.
subtasks	ObjectArray	The SubtaskInstance array, which contains the information of all subtasks.

Data structure of SubtaskInstance

Parameter	Type	Description
id	Long	The ID of the subtask instance.
name	String	The name of the subtask.
seriesId	Long	The serial number of the subtask.
description	String	The description of the subtask.
className	String	The class name corresponding to the subtask.
timeout	Integer	The timeout period of the subtask, in seconds.
status	String	The status of the subtask. Valid values: PENDING READY RUNNING CANCELING FAILED SUCCESSFUL
operation	String	The operation performed by the subtask. Valid values: EXECUTE RETRY ROLLBACK SKIP CANCEL
executor	String	The node that executed the subtask.
runTime	Integer	The number of executions of the subtask.
context	String	The execution context of the subtask.
createTime	String	The time when the subtask was created.
startTime	String	The start time of the subtask.
finishTime	String	The end time of the subtask.
nodeType	String	The node type, for example, JAVA_TASK.
paralleIdx	Integer	The index of a parallel subtask. -1 indicates that the subtask is not a parallel subtask.
upstreams	LongArray	The IDs of upstream subtasks.
downstream	LongArray	The IDs of downstream subtasks.
prohibitRollback	Boolean	Indicates whether rollback was supported by the subtask.

Previous topic

Rules for generating AK/SK signatures

Next topic

Query software packages