ListTables API Overview for Data Map Table Retrieval - DataWorks - Alibaba Cloud - DataWorks

Operation description

DataWorks Basic Edition or a higher edition is required.

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

dataworks:ListTables

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ParentMetaEntityId	string	Yes	The ID of the parent-level metadata entity. You can obtain this value from the response of the ListDatabases or ListSchemas operation. For more information, see Metadata entity concepts. The value can be the database to which the table belongs. The ParentMetaEntityId format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}`. Use an empty string as a placeholder for levels that do not exist. The value can also be the database schema to which the table belongs. The ParentMetaEntityId format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}`. Use an empty string as a placeholder for levels that do not exist. Note You can set ParentMetaEntityId to a database schema only when the database type supports schemas (`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`, and the three-level model must be enabled for the maxcompute type). Otherwise, you can set this parameter only to a database. For the maxcompute and dlf types, use an empty string as a placeholder for the instance ID. For the maxcompute type, the database name is the MaxCompute project name. For the starrocks type, the data catalog identifier is the catalog name. For the dlf type, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder. The following examples show the ParentMetaEntityId formats for common types: `maxcompute-project:::project_name` `maxcompute-schema:::project_name:schema_name` (only when the three-level model is enabled for the project) `dlf-database::catalog_id:database_name` `hms-database:instance_id::database_name` `holo-schema:instance_id::database_name:schema_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Note Where: `instance_id`: The instance ID. This value is required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string. This value is required when the data source is registered by using a connection string. `catalog_id`: The DLF catalog ID. `project_name`: The MaxCompute project name. `database_name`: The database name. `schema_name`: The schema name.	maxcompute-project:::project_name
Name	string	No	The name. Fuzzy match is supported.	abc
Comment	string	No	The comment. Fuzzy match is supported.	this is a comment
TableTypes	array	No	The list of table types to query. If this parameter is left empty, all types are queried.
	string	No	The table type. Valid values vary based on the database type.	TABLE
SortBy	string	No	The field by which to sort the results. Default value: CreateTime. Valid values: CreateTime: creation time ModifyTime: modification time Name: name TableType: table type	CreateTime
Order	string	No	The sort order. Default value: Asc. Valid values: Asc: ascending order Desc: descending order	Asc
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The page size. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	E25887B7-579C-54A5-9C4F-83A****
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination result.
TotalCount	integer	The total number of entries.	100
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
Tables	array	The list of data tables.
	Table	The details of the data table.

Note:

The Table objects returned in Tables are simplified structures that do not include the following properties:

TechnicalMetadata
BusinessMetadata

To obtain the technical metadata or business metadata of a table, call the GetTable operation to retrieve the complete Table object.

Examples

Success response

JSON format

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Tables": [
      {
        "Id": "dlf-table::catalog_id:database_name::table_name",
        "Name": "table_name",
        "Comment": "测试表",
        "TableType": "TABLE",
        "PartitionKeys": [
          "ds"
        ],
        "ParentMetaEntityId": "dlf-database::catalog_id:database_name",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000,
        "TechnicalMetadata": {
          "Owner": "test_user",
          "Location": "oss://test-bucket/test_tbl",
          "Compressed": false,
          "InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
          "OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
          "SerializationLibrary": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
          "Parameters": {
            "key": "value"
          }
        },
        "BusinessMetadata": {
          "Readme": "## 使用说明",
          "CustomAttributes": {
            "key": [
              "张三"
            ]
          },
          "Tags": [
            {
              "Key": "tag_key",
              "Value": "tag_value"
            }
          ],
          "Categories": [
            [
              {
                "Id": "CATEGORY.456",
                "Name": "测试类目",
                "ParentId": "CATEGORY.123"
              }
            ]
          ],
          "UpstreamTasks": [
            {
              "Id": 123456,
              "Name": "test_task"
            }
          ],
          "Extension": {
            "ProjectId": 234,
            "EnvType": "Dev",
            "ViewCount": 0,
            "ReadCount": 0,
            "FavorCount": 0
          }
        },
        "StatisticsInfos": {
          "key": ""
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.