GetTable
調用GetTable介面擷取指定表的詳細資料。
注意事項
該介面支援兩種查詢方式:按名稱查詢(傳入tableBucketARN、namespace和name)或按ARN查詢(傳入tableArn)。兩種方式二選一,不可混用。
許可權說明
API | Action | 說明 |
GetTable | oss:GetTable | 擷取表資訊(同時檢查Table Policy;admin使用者免檢) |
請求文法
GET /get-table 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(與namespace、name組合使用)。按名稱查詢時必填,與tableArn參數互斥。 |
namespace | 字串 | 否 | my_namespace | 表所在的命名空間,按名稱查詢時必填。位於Query參數中。 |
name | 字串 | 否 | my_table | 表名,按名稱查詢時必填。位於Query參數中。 |
tableArn | 字串 | 否 | acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id | 表ARN(單獨使用),按ARN查詢時必填,與tableBucketARN/namespace/name參數互斥。位於Query參數中。 |
響應參數
名稱 | 資料類型 | 樣本值 | 描述 |
name | 字串 | my_table | 表名稱。 |
namespace | 數組 | - | 表所在的命名空間名稱數組。 |
tableARN | 字串 | acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table-id | 表的ARN。 |
format | 字串 | ICEBERG | 表格式,取值為ICEBERG。 |
versionToken | 字串 | abc123def456 | 表的版本token,用於樂觀鎖控制。 |
metadataLocation | 字串 | oss://bucket/metadata/00000-xxx.metadata.json | 表metadata檔案的OSS路徑。 |
warehouseLocation | 字串 | oss://data-bucket/warehouse/ | 表warehouse的OSS路徑。 |
type | 字串 | customer | 表類型,取值為customer。 |
createdAt | 字串 | 2024-01-01T00:00:00.000000Z | 表建立時間,ISO 8601格式。 |
createdBy | 字串 | 1234567890 | 表的建立者帳號ID。 |
modifiedAt | 字串 | 2024-06-01T00:00:00.000000Z | 表最後修改時間,ISO 8601格式。 |
modifiedBy | 字串 | 1234567890 | 表最後修改者的帳號ID。 |
ownerAccountId | 字串 | 1234567890 | 表擁有者的帳號ID。 |
tableBucketId | 字串 | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | 表所屬的Table Bucket ID。 |
namespaceId | 字串 | ns-xxxxxxxx | 表所屬的Namespace ID。 |
樣本
請求樣本
GET /get-table?tableBucketARN=acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket&namespace=my_namespace&name=my_table 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
{
"name": "my_table",
"namespace": ["my_namespace"],
"tableARN": "acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id",
"format": "ICEBERG",
"versionToken": "aaabbb",
"metadataLocation": "oss://data-bucket/metadata/00000-xxx.metadata.json",
"warehouseLocation": "oss://data-bucket/warehouse/",
"type": "customer",
"createdAt": "2024-01-01T00:00:00.000000Z",
"createdBy": "1234567890",
"modifiedAt": "2024-06-01T00:00:00.000000Z",
"modifiedBy": "1234567890",
"ownerAccountId": "1234567890",
"tableBucketId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"namespaceId": "ns-xxxxxxxx"
}SDK
GetTable介面所對應的各語言SDK如下:
命令列工具ossutil
GetTable介面所對應的ossutil命令,請參見get-table。
錯誤碼
錯誤碼 | HTTP狀態代碼 | 描述 |
BadRequestException | 400 | 請求無效或格式錯誤。 |
ForbiddenException | 403 | 調用者無權執行此請求。 |
NotFoundException | 404 | 請求的資源不存在。 |