GetCatalog API Reference for Data Map Catalog - 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:GetCatalog

get

*All Resource

*

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

Response elements

Element	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.