GetTable - Retrieve table details | OSS Tables API - Object Storage Service

Remarques sur l'utilisation

Interrogez une table par son nom (tableBucketARN, namespace et name) ou par son ARN (tableArn). Ces deux méthodes sont mutuellement exclusives.

Autorisations

API

Action

Description

GetTable

oss:GetTable

Récupère les informations de la table. Vérifie également la politique de la table. Les utilisateurs administrateurs en sont exemptés.

Syntaxe de la requête

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

Paramètres de requête

Parameter

Type

Required

Example value

Description

tableBucketARN

String

No

acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket

L'ARN du Table Bucket. À utiliser avec namespace et name pour les requêtes par nom. Mutuellement exclusif avec tableArn.

namespace

String

No

my_namespace

Le namespace de la table. Requis pour les requêtes par nom. Transmis dans la chaîne de requête.

name

String

No

my_table

Le nom de la table. Requis pour les requêtes par nom. Transmis dans la chaîne de requête.

tableArn

String

No

acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table_id

L'ARN de la table. Requis pour les requêtes par ARN. Transmis dans la chaîne de requête. Mutuellement exclusif avec tableBucketARN, namespace et name.

Paramètres de réponse

Parameter

Type

Example value

Description

name

String

my_table

Le nom de la table.

namespace

Array

-

Tableau des noms de namespace où réside la table.

tableARN

String

acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/table-id

L'ARN de la table.

format

String

ICEBERG

Le format de la table. Valeur valide : ICEBERG.

versionToken

String

abc123def456

Jeton de version pour le verrouillage optimiste.

metadataLocation

String

oss://bucket/metadata/00000-xxx.metadata.json

Chemin OSS vers le fichier de métadonnées de la table.

warehouseLocation

String

oss://data-bucket/warehouse/

Chemin OSS vers l'entrepôt de la table.

type

String

customer

Type de table. Valeur valide : customer.

createdAt

String

2024-01-01T00:00:00.000000Z

Heure de création de la table au format ISO 8601.

createdBy

String

1234567890

ID du compte du créateur de la table.

modifiedAt

String

2024-06-01T00:00:00.000000Z

Dernière heure de modification au format ISO 8601.

modifiedBy

String

1234567890

ID du compte du dernier utilisateur ayant modifié la table.

ownerAccountId

String

1234567890

ID du compte du propriétaire de la table.

tableBucketId

String

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ID du Table Bucket contenant la table.

namespaceId

String

ns-xxxxxxxx

ID du namespace contenant la table.

Exemples

Exemple de requête

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

Exemple de réponse

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 pris en charge :

Outil de ligne de commande ossutil

Commande ossutil équivalente : get-table.

Codes d'erreur

Error code

HTTP status code

Description

BadRequestException

400

La requête n'est pas valide ou est mal formatée.

ForbiddenException

403

Vous n'êtes pas autorisé à effectuer cette opération.

NotFoundException

404

La ressource demandée n'existe pas.