GetTable - Retrieve table details | OSS Tables API - Object Storage Service: Central de Documentação do Alibaba Cloud

Notas de uso

Nota

Esta API oferece suporte apenas a tabelas Iceberg, não a tabelas Lance. Para consultar tabelas Lance, use a Lance REST Namespace API ou o Lance ecosystem (Spark, Trino, and other compute engines).

Consulte uma tabela pelo nome (tableBucketARN, namespace e name) ou pelo ARN (tableArn). Os dois métodos são mutuamente exclusivos.

Permissões

API	Action	Descrição
GetTable	oss:GetTable	Recupera informações da tabela e verifica sua política. Usuários administradores estão isentos dessa verificação.

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Valor de exemplo	Descrição
tableBucketARN	String	Não	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket	ARN do Table Bucket. Use com `namespace` e `name` para consultas por nome. Mutuamente exclusivo com `tableArn`.
namespace	String	Não	my_namespace	Namespace da tabela. Obrigatório para consultas por nome. Transmitido na string de consulta.
name	String	Não	my_table	Nome da tabela. Obrigatório para consultas por nome. Transmitido na string de consulta.
tableArn	String	Não	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id	ARN da tabela. Obrigatório para consultas por ARN. Transmitido na string de consulta. Mutuamente exclusivo com `tableBucketARN`, `namespace` e `name`.

Parâmetros de resposta

Parâmetro	Tipo	Valor de exemplo	Descrição
name	String	my_table	Nome da tabela.
namespace	Array	-	Array com os nomes dos namespaces onde a tabela reside.
tableARN	String	acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table-id	ARN da tabela.
format	String	ICEBERG	Formato da tabela. Valor válido: `ICEBERG`.
versionToken	String	abc123def456	Token de versão para bloqueio otimista.
metadataLocation	String	oss://bucket/metadata/00000-xxx.metadata.json	Caminho no OSS para o arquivo de metadados da tabela.
warehouseLocation	String	oss://data-bucket/warehouse/	Caminho no OSS para o warehouse da tabela.
type	String	customer	Tipo da tabela. Valor válido: `customer`.
createdAt	String	2024-01-01T00:00:00.000000Z	Data e hora de criação da tabela no formato ISO 8601.
createdBy	String	1234567890	ID da conta que criou a tabela.
modifiedAt	String	2024-06-01T00:00:00.000000Z	Data e hora da última modificação no formato ISO 8601.
modifiedBy	String	1234567890	ID da conta que modificou a tabela pela última vez.
ownerAccountId	String	1234567890	ID da conta proprietária da tabela.
tableBucketId	String	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx	ID do Table Bucket que contém a tabela.
namespaceId	String	ns-xxxxxxxx	ID do namespace ao qual a tabela pertence.

Exemplos

Exemplo de solicitação

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****

Exemplo de resposta

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"
}

SDKs

SDKs compatíveis:

Ferramenta de linha de comando ossutil

Comando equivalente no ossutil: get-table.

Códigos de erro

Código de erro	Código de status HTTP	Descrição
BadRequestException	400	A solicitação é inválida ou tem formato incorreto.
ForbiddenException	403	Você não tem autorização para executar esta operação.
NotFoundException	404	O recurso solicitado não existe.