GetTableBucketMaintenanceConfiguration

Usage notes

The response includes the status and parameters of the Iceberg unreferenced file removal policy.
If no maintenance policy is configured, the returned status is disabled.

Permissions

API	Action	Description
GetTableBucketMaintenanceConfiguration	oss:GetTableBucketMaintenanceConfiguration	Retrieves the maintenance configuration of a Table Bucket.

Request syntax

GET /buckets/{tableBucketARN}/maintenance HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

Request parameters

Parameter	Type	Required	Example	Description
tableBucketARN	string	Yes	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket	The ARN of the Table Bucket. The format is `acs:osstables:{region}:{accountId}:bucket/{bucketName}`.

Response parameters

Parameter	Type	Example	Description
tableBucketARN	string	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket	The ARN of the Table Bucket.
configuration	container	-	The maintenance configuration container. Contains the `icebergUnreferencedFileRemoval` object with the policy `status` and `settings`, including `unreferencedDays` and `nonCurrentDays`.

Examples

Request example

GET /buckets/acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket/maintenance HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
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

{
   "tableBucketARN": "acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket",
   "configuration": {
      "icebergUnreferencedFileRemoval": {
         "status": "enabled",
         "settings": {
            "icebergUnreferencedFileRemoval": {
               "unreferencedDays": 3,
               "nonCurrentDays": 10
            }
         }
      }
   }
}

SDKs

Supported SDKs:

ossutil command-line tool

The corresponding ossutil command is get-table-bucket-maintenance-configuration.

Error codes

Error code	HTTP status code	Description
ForbiddenException	403	You do not have permission to perform this request.
NotFoundException	404	The requested resource does not exist.