All Products
Search
Document Center

Object Storage Service:Describe a table

Last Updated:Jun 03, 2026

Retrieves table details, including schema and creation time.

Notes

Identify a table by ARN with --table-arn, or by combining --table-bucket-arn, --namespace, and --name.

Syntax

ossutil tables-api get-table (--table-arn value | --table-bucket-arn value --namespace value --name value) [flags]

Parameter

Type

Description

--name

string

Table name. Requires --table-bucket-arn and --namespace.

--namespace

string

Table namespace. Requires --table-bucket-arn and --name.

--table-arn

string

ARN of the table in the format acs:osstables:{region}:{uid}:bucket/{bucket-name}/table/{namespace}/{table-name}. Alternative to the --table-bucket-arn, --namespace, and --name combination.

--table-bucket-arn

string

ARN of the table bucket in the format acs:osstables:{region}:{uid}:bucket/{bucket-name}. Requires --namespace and --name.

Note

Examples

  • Describe a table by namespace and name:

    ossutil tables-api get-table --table-bucket-arn acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket --namespace my_namespace --name my_table
  • Describe a table by ARN:

    ossutil tables-api get-table --table-arn acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket/table/my_namespace/my_table