GetTableMaintenanceJobStatus - OSS Tables API - Object Storage Service

Permissions

API	Action	Description
GetTableMaintenanceJobStatus	oss:GetTableMaintenanceJobStatus	Retrieves the status of table maintenance jobs.

Request syntax

GET /tables/{tableBucketARN}/{namespace}/{name}/maintenance-job-status HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
x-oss-table-arn: {tableArn}

Request parameters

Parameter	Type	Required	Example	Description
tableBucketARN	string	Yes	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket	The Table Bucket ARN in the format `acs:osstables:{region}:{uid}:bucket/{bucketName}`. Part of the URI.
namespace	string	Yes	my_namespace	The namespace of the table. Part of the URI.
name	string	Yes	my_table	The table name. Part of the URI.
x-oss-table-arn	string	Required for admin users	-	The ARN of the table.

Response parameters

Parameter

Type

Example

Description

tableARN

string

acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table-id

The ARN of the table.

status

container

-

Contains the status of automatic maintenance jobs, including the icebergCompaction, icebergSnapshotManagement, and icebergUnreferencedFileRemoval child objects. Each child object has three fields: status (job status), failureMessage (failure reason, returned only on failure), and lastRunTimestamp (last execution time).

Valid values for status:

Disabled: Maintenance not enabled.
Not_Yet_Run: Enabled but not yet run.
Successful: Job succeeded.
Failed: Job failed.

The system sets Disabled and Not_Yet_Run. The backend maintenance service writes Successful and Failed through SetTableMaintenanceJobStatus.

Examples

Request example

GET /tables/acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket/my_namespace/my_table/maintenance-job-status HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: Thu, 10 Apr 2025 08:00:00 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/osstables/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c****

Response example

HTTP/1.1 200 OK
Server: AliyunOSS
x-oss-request-id: 5C06A3B67B8B5A3DA422****
x-oss-server-time: 3
Content-Type: application/json


{
   "tableARN": "acs:osstable:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id",
   "status": {
      "icebergCompaction": {
         "status": "Successful",
         "failureMessage": "",
         "lastRunTimestamp": "2024-01-15T10:30:00.000000Z"
      },
      "icebergSnapshotManagement": {
         "status": "Successful",
         "failureMessage": "",
         "lastRunTimestamp": "2024-01-15T08:00:00.000000Z"
      },
      "icebergUnreferencedFileRemoval": {
         "status": "Successful",
         "failureMessage": "",
         "lastRunTimestamp": "2024-01-15T06:00:00.000000Z"
      }
   }
}

SDKs

Available SDKs for GetTableMaintenanceJobStatus:

ossutil CLI

Corresponding ossutil command: get-table-maintenance-job-status.

Error codes

Error code	HTTP status code	Description
ForbiddenException	403	The caller lacks the required permission.
NotFoundException	404	The specified resource does not exist.