Use ListCatalogs API to Retrieve Data Map Catalogs - DataWorks - Alibaba Cloud - DataWorks

Queries a list of catalogs in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawler types are supported. For the DLF metadata crawler type, all supported data catalogs are returned. For the StarRocks metadata crawler type, data catalogs in a specific instance are returned.

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:ListCatalogs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ParentMetaEntityId	string	Yes	The parent entity ID. For more information, see Concepts related to metadata entities. Currently, only the DLF and StarRocks types are supported. For the DLF type, you can query all catalog lists. The format of `ParentMetaEntityId` is `DLF`. For the StarRocks type, you can query the catalogs of a specific instance. The format of `ParentMetaEntityId` `is StarRocks:(instance_id\|encoded_jdbc_url)`. Note `instance_id`: The instance ID. Required if the data source is registered in instance mode. `encoded_jdbc_url`: The JDBC connection string encoded with URL encoding. Required if the data source is registered in connection-string mode.	dlf
Name	string	No	The name. Supports fuzzy matching.	abc
Comment	string	No	The comment. Supports token-based matching.	this is a comment
Types	array	No	The type. Supports exact match. If left empty, all types are queried.
	string	No	The catalog type.	HIVE
SortBy	string	No	The sort field. Default value: CreateTime. Valid values: CreateTime ModifyTime Name Type	CreateTime
Order	string	No	The order in which the tables are sorted. 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 number of records per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	Responses.
RequestId	string	The request ID.	317CD7D0-AB36-XXXXXX
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination result.
TotalCount	integer	The total number of records.	1
PageNumber	integer	The page number.	1
PageSize	integer	The number of records per page.	10
Catalogs	array	The catalog.
	Catalog	The catalog details.

Examples

Success response

JSON format

{
  "RequestId": "317CD7D0-AB36-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Catalogs": [
      {
        "Id": "dlf-catalog:123456XXX:test_catalog\nstarrocks-catalog:c-abc123xxx:default_catalog",
        "Name": "default_catalog",
        "Comment": "this is a comment\n",
        "Type": "Internal",
        "CreateTime": 1722073854000,
        "ModifyTime": 1722073854000,
        "ParentMetaEntityId": "dlf\nstarrocks:c-abc123xxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.