ListCatalogs - Data Lake Formation - Alibaba Cloud Documentation Center

Retrieve 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

list

*All Resource

*

None

Request syntax

GET /api/metastore/catalogs/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
IdPattern	string	No	A regular expression to match catalog IDs.	.*
NextPageToken	string	No	The token for the next page of results. This is returned in the previous response. For the first request, pass an empty string ('').	‘’
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The response.
Catalogs	array	The catalogs.	[{"CatalogId":"xx"}]
	Catalog	The details of the catalog.
Code	string	The description of the status code.	OK
Message	string	The error message.	.
NextPageToken	string	The paging token.	2cb472ec1bf84f8d92f9c4baa0d21c19aa
RequestId	string	The request ID.	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Catalogs": [
    {
      "CatalogId": "1344371",
      "Description": "测试",
      "LocationUri": "oss://dlf-test-oss-location/",
      "Owner": "acs:ram::[accountId]:root",
      "CreatedBy": "acs:ram::[accountId]:root\n",
      "CreateTime": 1640662815603,
      "UpdateTime": 1640662815603,
      "Status": "CREATED",
      "CatalogType": "HMS",
      "DefaultCatalog": true,
      "ThriftEnabled": true,
      "JdbcEnabled": true,
      "StorageAccessConfig": ""
    }
  ],
  "Code": "OK",
  "Message": ".",
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.