All Products
Search
Document Center

Tablestore:DescribeGlobalTable

Last Updated:Jan 15, 2026

Queries information about the physical tables in a global table.

Request syntax

message DescribeGlobalTableRequest {
  optional string globalTableId = 1;
  required string globalTableName = 2;
  optional PhyTable phyTable = 3;
  optional bool returnRpo = 4;
}

Parameter

Type

Required

Description

globalTableId

string

No

The ID of the global table.

globalTableName

string

Yes

The name of the global table.

phyTable

PhyTable

No

The filter conditions for physical tables. Set the region ID or instance name of the physical table.

returnRpo

bool

No

Specifies whether to also return the Recovery Point Objective (RPO).

Response syntax

message DescribeGlobalTableResponse {
  required string globalTableId = 2;
  required GlobalTableStatus status = 3;
  repeated PhyTable phyTables = 4;
  optional ServeMode serveMode = 5;
}

Parameter

Type

Description

globalTableId

string

The ID of the global table.

status

GlobalTableStatus

Global table name

phyTables

PhyTable

A list of detailed information about the physical tables.

serveMode

ServeMode

The service mode.