GetTableMaintenanceConfiguration

更新時間:
Copy as MD

調用GetTableMaintenanceConfiguration介面擷取指定表的自動維護配置資訊。

注意事項

  • 返回結果包含所有維護類型的配置,包括icebergCompaction(表壓縮)和icebergSnapshotManagement(快照管理)。

  • 每種維護類型的配置包含status(啟用狀態)和settings(配置參數)。

許可權說明

API

Action

說明

GetTableMaintenanceConfiguration

oss:GetTableMaintenanceConfiguration

擷取表維護配置(同時檢查Table Policy;admin使用者免檢)

請求文法

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

請求參數

名稱

資料類型

是否必選

樣本值

描述

tableBucketARN

字串

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

Table BucketARN,格式為acs:osstables:{region}:{uid}:bucket/{bucketName}。位於URI中。

namespace

字串

my_namespace

表所在的命名空間名稱。位於URI中。

name

字串

my_table

表名稱。位於URI中。

響應參數

名稱

資料類型

樣本值

描述

tableARN

字串

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

表的ARN。

configuration

容器

-

維護設定物件,包含icebergCompaction(表壓縮配置)和icebergSnapshotManagement(快照管理配置)兩個子物件。每個子物件包含status(啟用狀態)和settings(配置參數)。

樣本

請求樣本

GET /tables/acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket/my_namespace/my_table/maintenance 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****

返回樣本

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


{
   "tableARN": "acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id",
   "configuration": {
      "icebergCompaction": {
         "status": "enabled",
         "settings": {
            "icebergCompaction": {
               "targetFileSizeMB": 512,
               "strategy": "auto"
            }
         }
      },
      "icebergSnapshotManagement": {
         "status": "enabled",
         "settings": {
            "icebergSnapshotManagement": {
               "minSnapshotsToKeep": 1,
               "maxSnapshotAgeHours": 120
            }
         }
      }
   }
}

SDK

GetTableMaintenanceConfiguration介面所對應的各語言SDK如下:

命令列工具ossutil

GetTableMaintenanceConfiguration介面所對應的ossutil命令,請參見get-table-maintenance-configuration

錯誤碼

錯誤碼

HTTP狀態代碼

描述

ForbiddenException

403

調用者無權執行此請求。

NotFoundException

404

請求的資源不存在。