使用DescribeTable接口可以查询指定表的结构、预留读/写吞吐量详情等信息。
API说明请参见DescribeTable。
前提条件
已初始化Client。更多信息，请参见初始化OTSClient。
已创建数据表。更多信息，请参见创建数据表。
接口
/**
* 获取一个表的信息，包括表的结构信息、配置信息、预留读/写吞吐量详情和Stream设置信息。
* @api
* @param [] $request 请求参数。
* @return [] 请求返回。
* @throws OTSClientException 当参数检查出错或服务端返回校验出错时抛出异常。
* @throws OTSServerException 当OTS服务端返回错误时抛出异常。
*/
public function describeTable(array $request);参数
请求信息
请求参数
参数 | 说明 |
table_name | 表名。 |
请求格式
$result = $client->describeTable([
'table_name' => '<string>', //设置表名，必须设置。
]);响应信息
响应参数
参数 | 说明 |
table_meta | 表的结构信息，包括如下内容：
|
capacity_unit_details | 表的预留读写吞吐量配置详情，包括如下内容：
|
table_options | 表的配置信息，包括如下内容：
|
stream_details | 数据表的Stream信息，包括如下内容：
|
结果格式
[
'table_meta' => [
'table_name' => '<string>',
'primary_key_schema' => [
['<string>', <PrimaryKeyType>],
['<string>', <PrimaryKeyType>, <PrimaryKeyOption>]
],
'defined_column'=> [
['<string>', <DefinedColumnType>]
]
],
'capacity_unit_details' => [
'capacity_unit' => [
'read' => <integer>,
'write' => <integer>
],
'last_increase_time' => <integer>,
'last_decrease_time' => <integer>
],
'table_options' => [
'time_to_live' => <integer>,
'max_versions' => <integer>,
'deviation_cell_version_in_sec => <integer>
],
'stream_details' => [
'enable_stream' => true || false,
'stream_id' => '<string>',
'expiration_time' => <integer>,
'last_enable_time' => <integer>
]
] 示例
以下示例用于获取表的描述信息。
$result = $client->describeTable([
'table_name' => 'mySampleTable',
]);
var_dump($result);