调用ListTables接口列举指定Table Bucket中的表。
注意事项
该接口仅支持 Iceberg 表,不支持 Lance 表。如需列举 Lance 表,请通过 Lance REST Namespace API 或 Lance 生态(Spark、Trino 等计算引擎)完成。
-
单次请求最多返回1000条记录,可通过continuationToken进行分页查询。
-
可通过namespace参数限定只列举指定命名空间下的表。
-
可通过prefix参数按表名前缀过滤结果。
权限说明
|
API |
Action |
说明 |
|
ListTables |
oss:ListTables |
列出表 |
请求语法
GET /tables/{tableBucketARN} 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}:{uid}:bucket/{bucketName}。位于URI中。 |
|
continuationToken |
字符串 |
否 |
xxx-continuation-token |
分页token,从上一次ListTables响应中获取,用于获取下一页结果。首次请求无需指定。位于Query参数中。 |
|
maxTables |
整数 |
否 |
100 |
最大返回数量,取值范围1~1000,默认1000。位于Query参数中。 |
|
namespace |
字符串 |
否 |
my_namespace |
限定命名空间,仅列举该命名空间下的表。位于Query参数中。 |
|
prefix |
字符串 |
否 |
my_ |
表名前缀过滤,仅返回以该前缀开头的表。位于Query参数中。 |
响应参数
|
名称 |
数据类型 |
示例值 |
描述 |
|
tables |
数组 |
- |
表列表。每个元素包含name(表名)、namespace(命名空间名称数组)、tableARN(表ARN)、type(表类型)、createdAt(创建时间)、modifiedAt(修改时间)。 |
|
continuationToken |
字符串 |
xxx-continuation-token |
分页token。当还有更多数据时返回此字段,用于获取下一页结果。 |
示例
请求示例
GET /tables/acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket?namespace=my_namespace 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
{
"continuationToken": "xxxxx",
"tables": [
{
"name": "my_table",
"namespace": ["my_namespace"],
"tableARN": "acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id",
"type": "customer",
"createdAt": "2024-01-01T00:00:00.000000Z",
"modifiedAt": "2024-06-01T00:00:00.000000Z"
}
]
}
SDK
ListTables接口所对应的各语言SDK如下:
命令行工具ossutil
ListTables接口所对应的ossutil命令,请参见list-tables。
错误码
|
错误码 |
HTTP状态码 |
描述 |
|
BadRequestException |
400 |
请求无效或格式错误。 |
|
ForbiddenException |
403 |
调用者无权执行此请求。 |
|
NotFoundException |
404 |
请求的资源不存在。 |