GetTable - テーブル詳細の取得 | OSS Tables API - Object Storage Service

指定されたテーブルの詳細情報を取得します。

注意事項

説明

この API は Iceberg テーブルのみをサポートし、Lance テーブルはサポートしていません。Lance テーブルをクエリするには、Lance REST Namespace API または Lance エコシステム (Spark、Trino、およびその他のコンピュートエンジン) を使用してください。

テーブルは、名前 (tableBucketARN、namespace、name) または ARN (tableArn) でクエリします。この 2 つのメソッドは相互排他的です。

権限

API	アクション	説明
GetTable	oss:GetTable	テーブル情報を取得します。この操作ではテーブルポリシーのチェックも行われますが、管理者ユーザーはこのチェックの対象外です。

リクエスト構文

GET /get-table HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

リクエストパラメーター

パラメーター	型	必須	値の例	説明
tableBucketARN	String	いいえ	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket	テーブルバケットの ARN。名前によるクエリの場合、`namespace` および `name` と共に使用します。`tableArn` とは相互排他的です。
namespace	String	いいえ	my_namespace	テーブルの名前空間。名前によるクエリの場合に必須です。クエリ文字列で渡されます。
name	String	いいえ	my_table	テーブル名。名前によるクエリの場合に必須です。クエリ文字列で渡されます。
tableArn	String	いいえ	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id	テーブルの ARN。ARN によるクエリの場合に必須です。クエリ文字列で渡されます。`tableBucketARN`、`namespace`、`name` とは相互排他的です。

レスポンスパラメーター

パラメーター	型	値の例	説明
name	String	my_table	テーブルの名前。
namespace	Array	-	テーブルが属する名前空間名の配列。
tableARN	String	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table-id	テーブルの ARN。
format	String	ICEBERG	テーブルフォーマット。有効な値：`ICEBERG`。
versionToken	String	abc123def456	楽観的ロックのためのバージョントークン。
metadataLocation	String	oss://bucket/metadata/00000-xxx.metadata.json	テーブルメタデータファイルへの OSS パス。
warehouseLocation	String	oss://data-bucket/warehouse/	テーブルウェアハウスへの OSS パス。
type	String	customer	テーブルタイプ。有効な値：`customer`。
createdAt	String	2024-01-01T00:00:00.000000Z	テーブルの作成時刻 (ISO 8601 形式)。
createdBy	String	1234567890	テーブル作成者のアカウント ID。
modifiedAt	String	2024-06-01T00:00:00.000000Z	最終更新時刻 (ISO 8601 形式)。
modifiedBy	String	1234567890	最終更新者のアカウント ID。
ownerAccountId	String	1234567890	テーブル所有者のアカウント ID。
tableBucketId	String	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx	テーブルを含むテーブルバケットの ID。
namespaceId	String	ns-xxxxxxxx	テーブルを含む名前空間の 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

サポートされている SDK：

ossutil コマンドラインツール

同等の ossutil コマンド：get-table。

エラーコード

エラーコード	HTTP ステータスコード	説明
BadRequestException	400	リクエストが無効であるか、形式が正しくありません。
ForbiddenException	403	この操作を実行する権限がありません。
NotFoundException	404	リクエストされたリソースは存在しません。