ListTables

更新時間:
Copy as MD

調用ListTables介面列舉指定Table Bucket中的表。

注意事項

  • 單次請求最多返回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 BucketARN,格式為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

請求的資源不存在。