GetTableMaintenanceJobStatus

更新时间:
复制为 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

请求的资源不存在。