Querying All Tables (Recommended)

Function

This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.

URI

• URI format

  GET /v1.0/{project_id}/databases/{database_name}/tables

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
  database_name	Yes	String	Name of the database where the table resides.

  Table 2 query parameter description

  Parameter	Mandatory	Type	Description
  keyword	No	String	Keywords used to filter table names.
  with-detail	No	Boolean	Whether to obtain detailed information about tables (such as owner and size). The default value is false.
  page-size	No	Integer	Paging size. The minimum value is 1 and the maximum value is 100.
  current-page	No	Integer	Current page number. The minimum value is 1.
  with-priv	No	Boolean	Whether to return permission information.
  table-type	No	String	Database table type. The options are as follows: MANAGED_TABLE: DLI table EXTERNAL_TABLE: OBS table VIRTUAL_VIEW: view
  datasource-type	No	String	Data source type. The options are as follows: CloudTable CSS DLI DWS Geomesa HBase JDBC Mongo OBS ODPS OpenTSDB Redis RDS
  without-tablemeta	No	Boolean	Whether to obtain the metadata of a table. The default value is false. If this parameter is set to true, the response speed can be greatly improved.

  

  The following is an example of the URL containing the query parameter:

  GET /v1.0/{project_id}/databases/{database_name}/tables?keyword=tb&with-detail=true

Request

None

Response

If with-detail is set to false in the URI, only values of tables-related parameters data_location, table_name, and table_type are returned.

Example Request

None

Example Response

{
  "is_success": true,
  "message": "",
  "table_count": 1,
  "tables": [
    { "create_time":1517364268000,
      "data_location":"OBS",
      "data_type":"csv",
      "last_access_time":1517364268000,
      "location":"obs://DLI/sqldata/data.txt",
      "owner":"test",     
      "partition_columns": ["a0"],
      "table_name":"obs_t",
      "table_size":0,
      "table_type":"EXTERNAL"
    }
  ]
}

Status Codes

Table 5 describes the status code.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.