查询实例库表信息
功能介绍
查询实例库表信息。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/instances/{instance_id}/table-info
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
database_name |
否 |
String |
参数解释: 数据库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
table_name |
否 |
String |
参数解释: 数据表名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认取值: en-us。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
table_meta_infos |
Array of TableMetaInfo objects |
参数解释: 要版本升级的批量实例。 |
table_names |
Array of strings |
参数解释: 数据表名称。 |
database_names |
Array of strings |
参数解释: 数据库名称。 |
参数 |
参数类型 |
描述 |
---|---|---|
column_type |
String |
参数解释: 列的数据类型。 取值范围: 不涉及。 |
extra |
String |
参数解释: 额外的信息,例如是否是自动递增列。 取值范围: 不涉及。 |
is_nullable |
String |
参数解释: 是否允许为NULL。 取值范围: 不涉及。 |
column_default |
String |
参数解释: 列的默认值。 取值范围: 不涉及。 |
column_key |
String |
参数解释: 是否是索引列。 取值范围: 不涉及。 |
column_name |
String |
参数解释: 列名。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询实例库表信息。
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/406f16a73f3045a7aca3b9a9d5bf361cin07/table-info
响应示例
状态码:200
Success.
{ "table_meta_infos" : null, "table_names" : null, "database_names" : [ "db1", "mysql" ] }
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。