调用GetTable接口获取指定表的详细信息。
注意事项
该接口仅支持 Iceberg 表，不支持 Lance 表。如需查询 Lance 表，请通过 Lance REST Namespace API 或 Lance 生态（Spark、Trino 等计算引擎）完成。
该接口支持两种查询方式：按名称查询（传入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 |
请求的资源不存在。 |