ListCatalogs - Data Lake Formation - Alibaba Cloud Documentation Center

Lists catalogs.

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

dlf:ListCatalogs

get

*All Resource

*

None

Request syntax

GET /dlf/v1/catalogs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
maxResults	integer	No	The maximum number of records to return in a single request.	1000
pageToken	string	No	The token to retrieve the next page of results. If the response does not include this token, pass an empty string ("").	""
catalogNamePattern	string	No	The pattern of the catalog name.	mi

Response elements

Element	Type	Description	Example
	object	The response body.
catalogs	array	A list of catalogs.
	Catalog	The catalog.
prepayResource	array	A list of subscription computing resources.
	PrepayResource	The subscription computing resource.
nextPageToken	string	The token to retrieve the next page of results. If this parameter is null, all results have been returned.	E8ABEB1C3DB893D16576269017992F57

Examples

Success response

JSON format

{
  "catalogs": [
    {
      "owner": "acs:ram::[accountId]:root",
      "createdAt": 1744970111419,
      "updatedBy": "acs:ram::[accountId]:root",
      "createdBy": "acs:ram::[accountId]:root",
      "name": "test_catalog",
      "id": "clg-paimon-xxxx",
      "type": "",
      "updatedAt": 1744970111419,
      "status": "NEW\nINITIALIZING\nINITIALIZE_FAILED\nRUNNING\nTERMINATED\nDELETING\nDELETE_FAILED \nDELETED\nSTORAGE_RESTRICTED ",
      "shareId": "",
      "options": {
        "key": "{\\\"comment\\\":\\\"test\\\"}"
      },
      "isShared": false
    }
  ],
  "prepayResource": [
    {
      "catalogId": "",
      "instanceId": "",
      "catalogName": "",
      "instanceStatus": "",
      "cu": 0,
      "gmtCreate": 0,
      "expireTime": 0
    }
  ],
  "nextPageToken": "E8ABEB1C3DB893D16576269017992F57"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.