GetTableMaintenanceJobStatus

更新時間:
Copy as MD

調用GetTableMaintenanceJobStatus介面擷取指定表的自動維護任務執行狀態。

許可權說明

API

Action

說明

GetTableMaintenanceJobStatus

oss:GetTableMaintenanceJobStatus

擷取表維護任務狀態。

請求文法

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}

請求參數

名稱

資料類型

是否必選

樣本值

描述

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中。

x-oss-table-arn

字串

admin 使用者必填

-

Table 的 ARN。

響應參數

名稱

資料類型

樣本值

描述

tableARN

字串

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

表的ARN。

status

容器

-

維護任務狀態物件,包含icebergCompaction、icebergSnapshotManagementicebergUnreferencedFileRemoval三個子物件。每個子物件包含status(任務狀態)、failureMessage(失敗原因,僅失敗時返回)、lastRunTimestamp(最後執行時間)。

各維護任務的 status 欄位合法值:

  • Disabled(維護配置未啟用)

  • Not_Yet_Run(已啟用但後台服務尚未執行)

  • Successful(執行成功)

  • Failed(執行失敗)

其中 Disabled 和 Not_Yet_Run 由系統自動產生,Successful 和 Failed 由後台維護服務通過 SetTableMaintenanceJobStatus 寫入。

樣本

請求樣本

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****

返回樣本

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"
      }
   }
}

SDK

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

命令列工具ossutil

GetTableMaintenanceJobStatus介面所對應的ossutil命令,請參見get-table-maintenance-job-status

錯誤碼

錯誤碼

HTTP狀態代碼

描述

ForbiddenException

403

調用者無權執行此請求。

NotFoundException

404

請求的資源不存在。