ListCatalogs - DataWorks - Alibaba Cloud Documentation Center

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListCatalogs	list	All Resources ``	none	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 starrocks:c-abc123xxx
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 parameters

Parameter	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	long	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.
CatalogList	Catalog	The catalog details.

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.