GetCatalog - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a catalog in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawlers are supported.

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:GetCatalog	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The catalog entity ID. Currently supports dlf and starrocks types. You can refer to the results returned by the ListCatalogs operation and the Concepts related to metadata entities. For the DLF type, the format is `dlf-catalog::catalog_id`. For the StarRocks type, the format is `starrocks-catalog:(instance_id\|encoded_jdbc_url):catalog_name`. Note `catalog_id`: The ID of the DLF catalog. `instance_id`: The instance ID, required if the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string. Required if the data source is registered in connection string mode. `catalog_name`: The name of the StarRocks catalog.	dlf-catalog:123456XXX:test_catalog starrocks-catalog:c-abc123xxx:default_catalog

Response parameters

Parameter	Type	Description	Example
	object	Responses.
RequestId	string	The request ID.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indicates whether the request was successful.	true
Catalog	Catalog	Catalog information.

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Catalog": {
    "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.