GetTableBucketMaintenanceConfiguration接口用于获取指定Table Bucket的维护配置信息。
注意事项
返回的维护配置包括Iceberg未引用文件清理策略的启用状态和相关参数。
如果Table Bucket未配置维护策略,返回的配置中status为disabled。
权限说明
API | Action | 说明 |
GetTableBucketMaintenanceConfiguration | oss:GetTableBucketMaintenanceConfiguration | 获取Table Bucket维护配置 |
请求语法
GET /buckets/{tableBucketARN}/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 Bucket的ARN,格式为acs:osstables:{region}:{accountId}:bucket/{bucketName}。 |
响应参数
名称 | 数据类型 | 示例值 | 描述 |
tableBucketARN | 字符串 | acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket | Table Bucket的ARN。 |
configuration | 容器 | - | 维护配置对象,包含icebergUnreferencedFileRemoval子对象,其中包含status(启用状态)和settings(具体配置参数,包括unreferencedDays和nonCurrentDays)。 |
示例
请求示例
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****返回示例
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
}
}
}
}
}SDK
GetTableBucketMaintenanceConfiguration接口所对应的各语言SDK如下:
命令行工具ossutil
GetTableBucketMaintenanceConfiguration接口所对应的ossutil命令为get-table-bucket-maintenance-configuration。
错误码
错误码 | HTTP状态码 | 描述 |
ForbiddenException | 403 | 调用者无权执行此请求。 |
NotFoundException | 404 | 请求的资源不存在。 |