GetTableObjects - AnalyticDB - Alibaba Cloud Documentation Center

Retrieves information about tables.

Operation description

Public endpoint for the region: adb.<region-id>.aliyuncs.com. For example, adb.cn-hangzhou.aliyuncs.com.
VPC endpoint for the region: adb-vpc.<region-id>.aliyuncs.com. For example, adb-vpc.cn-hangzhou.aliyuncs.com.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:getTableObjects

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
SchemaName	string	No	The database name.	adb_demo
OrderBy	string	No	The sorting criteria. The `Type` property specifies the sorting order. Valid values: Asc Desc The `Field` property specifies the field to sort by. Valid values: `TableName`, `TableSize`, `CreateTime`, and `UpdateTime`. Default value: `{"Type": "Desc","Field": "TableName"}`	{"Type": "Desc","Field": "TableName"}
FilterTblName	string	No	The table name.	test_tbl
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the integer data type. Default value: 1.	1
PageSize	integer	No	The number of records on each page. Valid values: 30 50 100 Default value: 30.	30
DBClusterId	string	Yes	The cluster ID.	am-bp1565u55p32****
FilterTblType	string	No	The table type. Valid values: -DIMENSION_TABLE -FACT_TABLE -EXTERNAL_TABLE Default value: empty	FACT_TABLE
FilterOwner	string	No	The owner.	admin
FilterDescription	string	No	The description.	description
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	863D51B7-5321-41D8-A0B6-A088B0******
PageNumber	integer	The page number. The value is a positive integer. Default value: 1.	1
PageSize	integer	The number of records on each page. Valid values: 30 (default) 50 100	30
TotalCount	integer	The total number of records.	1
Data	object	The returned data.
PageNumber	integer	The page number. The value is a positive integer. Default value: 1.	1
PageSize	integer	The number of records on each page. Valid values: 30 (default) 50 100	30
TotalCount	integer	The total number of records.	1
TableSummaryModels	array	The result array.
	TableSummaryModel	The summary information of the table.

Examples

Success response

JSON format

{
  "RequestId": "863D51B7-5321-41D8-A0B6-A088B0******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TotalCount": 1,
    "TableSummaryModels": [
      {
        "TableName": "tableName",
        "Owner": "abc",
        "TableType": "PHYSICAL_SCHEMA_NAME",
        "Description": "descrtiption",
        "TableSize": 1234,
        "CreateTime": "2023-01-05 13:17:55",
        "UpdateTime": "2023-01-05 13:17:55",
        "MvDetailModel": {
          "FirstRefreshTime": "2025-01-01 09:00:00",
          "BaseTableInfos": [
            {
              "TableName": "test_tbl",
              "BaseTableIsMv": false,
              "SchemaName": "test_db"
            }
          ],
          "ExplicitHit": 5,
          "BaseTableNames": [
            [
              "t1"
            ]
          ],
          "RemoteSize": 1234,
          "ImplicitHit": 20,
          "UpdatedAt": "2025-01-01 10:00:00",
          "QueryRewriteEnabled": false,
          "IsInactive": false,
          "LocalSize": 1234,
          "RefreshState": "FAST",
          "RefreshInterval": "(now() + INTERVAL '10' SECOND)",
          "ResourceGroup": "user_default"
        },
        "SchemaName": "schemaName",
        "SQL": "create table(a varchar)"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MDS.IllegalArgument	Invalid argument.	An invalid parameter is used.
400	MDS.InvalidPrivilege	No permissions.	You are not authorized to perform this operation.
400	MDS.MetaSchemaAlreadyExist	The database already exists.	The specified database already exists.
400	MDS.MetaSchemaNotExist	The database does not exist.	The specified database does not exist.
400	MDS.MetaTableAlreadyExist	The table already exists.	The specified table already exists.
400	MDS.MetaTableNotExist	The table is not found.	The specified table does not exist.
500	MDS.InternalError	An internal MDS error occurred.	An internal error occurred.
500	MDS.MetaVisitError	Failed to access metadata.	Failed to access the metadata.
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM authentication failed

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.