Updated on 2026-03-16 GMT+08:00

Querying Database and Table Information of an Instance

Function

This API is used to query database and table information of an instance. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/table-info

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
database_name	No	String	Definition Database name. Constraints N/A Range N/A Default Value N/A
table_name	No	String	Definition Data table name. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
table_meta_infos	Array of TableMetaInfo objects	Definition Database table metadata information.
table_names	Array of strings	Definition Data table names.
database_names	Array of strings	Definition Database names.

**Table 5** TableMetaInfo
Parameter	Type	Description
column_type	String	Definition Data type of a column. Range N/A
extra	String	Definition Extra information, for example, whether the column is an auto-increment column. Range N/A
is_nullable	String	Definition Whether the column data can be NULL. Range N/A
column_default	String	Definition Default value of a column. Range N/A
column_key	String	Definition Whether the column is an index column. Range N/A
column_name	String	Definition Column name. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying database and table information of an instance

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/406f16a73f3045a7aca3b9a9d5bf361cin07/table-info

Example Response

Status code: 200

Success.

{
  "table_meta_infos" : [ {
    "column_type" : "int unsigned",
    "extra" : "",
    "is_nullable" : "YES",
    "column_default" : "None",
    "column_key" : "",
    "column_name" : "age"
  }, {
    "column_type" : "int unsigned",
    "extra" : "",
    "is_nullable" : "NO",
    "column_default" : "None",
    "column_key" : "PRI",
    "column_name" : "id"
  }, {
    "column_type" : "tinyint(1)",
    "extra" : "",
    "is_nullable" : "YES",
    "column_default" : "None",
    "column_key" : "",
    "column_name" : "is_warhor"
  }, {
    "column_type" : "varchar(32)",
    "extra" : "",
    "is_nullable" : "YES",
    "column_default" : "None",
    "column_key" : "",
    "column_name" : "name"
  } ],
  "table_names" : [ ],
  "database_names" : [ ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management