All Products
Search
Document Center

Object Storage Service:GetLanceTaskStatus

Last Updated:Nov 02, 2026

Query the status, submission parameters, and execution result of a single task under the current table.

Permission notes

API

Action

Description

GetLanceTaskStatus

oss:GetTableMaintenanceJobStatus

Query a single maintenance task.

Request syntax

GET /lance/oss/v1/table/{id}/tasks/{task_id} HTTP/1.1
Host: {tableBucketHost}
Date: GMT Date
Authorization: SignatureValue

Request parameters

No business request body. For the common conventions of this interface (access address, table identifier, request and response headers, permissions, async submission and quota, status, error codes), see Lance table maintenance.

Parameter

Location

Data type

Required

Description

id

path

string

Yes

Current table identifier, default namespace$table_name.

task_id

path

string

Yes

Task ID returned by Submit.

delimiter

query

string

No

Table identifier delimiter, default $.

Response

HTTP/1.1 200 OK
Content-Type: application/json
x-oss-table-id: {table_id}

{
  "task_info": {
    "task_id": "11111111111111111111111111111111",
    "task_type": "lance_compact",
    "params": {
      "target_rows_per_fragment": 1048576,
      "materialize_deletions": true,
      "materialize_deletions_threshold": 0.1,
      "max_rows_per_group": 1024,
      "max_bytes_per_file": 0,
      "compaction_mode": "reencode"
    },
    "status": "submitted",
    "created_at": "2026-09-18T04:00:00.000000+00:00",
    "started_at": "",
    "completed_at": "",
    "result": {},
    "error": null
  }
}

Field

Type

Description

task_id

string

Task ID.

task_type

string

One of the five lance_ prefixed types.

params

object

The actually saved task parameters, including default values filled in by the server.

status

string

Current task status.

created_at

string

Task creation time.

started_at

string

Task start time; empty string when not started.

completed_at

string

Time when the terminal state was reached; empty string for non-terminal states.

result

object

Task execution result, initially {}; may contain nested objects and arrays. The result structure varies by task type.

error

object or null

Contains the error object when the known status is failed; null for other known statuses.

The top level contains only task_info; its object structure is shown in the table above. The example ID and time are for illustration only. Tasks that do not exist or do not belong to the current table return 404 / TaskNotFound / 10000.

Error codes

This interface uses the Lance unified JSON error format. For common error codes and the error response structure, see Lance table maintenance.