Retrieve Data Catalogs via ListCatalogs API in EMR Serverless Spark - E-MapReduce

View the list of data 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

emr-serverless-spark:ListCatalogs

list

*All Resource

*

None

Request syntax

GET /api/v1/workspaces/{workspaceId}/catalogs HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-d2d82aa09155****

Request parameters

Parameter	Type	Required	Description	Example
environment	string	No	The environment type. Valid values: dev : dev production : production	dev
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The data returned.
catalogs	array<object>	The data catalogs.
	array<object>	The data catalog.
catalogId	string	The ID of the data catalog.	15097**********
workspaceId	string	The workspace ID.	w-d2d82aa09155****
environments	array	The environment types.
	string	The environment type.	dev,production
catalogType	string	Indicates whether this is the default data catalog.	default_catalog
catalogProvider	string	The provider of the data catalog.	HMS
gmtCreate	integer	The time when the resource was created.	1760604889
gmtModified	integer	The time when the resource was last updated.	1760604889
resourceOwnerId	string	The ID of the resource owner.	15097**********
alias	string		alias
extras	object	Extra information.
	string	Extra information.	{"networkName":"hms","metastoreUrl":"thrift://master-1-1.c-70*******.cn-hangzhou.emr.aliyuncs.com:9083","keytabPath":"oss://****/hive.keytab","principal":"hive/master-1-1.c-70**************"}
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	The token to retrieve the next page of results.	1
totalCount	integer	The total number of entries.	200
maxResults	integer	The maximum number of entries to return on each page.	20

Examples

Success response

JSON format

{
  "catalogs": [
    {
      "catalogId": "15097**********",
      "workspaceId": "w-d2d82aa09155****\n",
      "environments": [
        "dev,production"
      ],
      "catalogType": "default_catalog",
      "catalogProvider": "HMS",
      "gmtCreate": 1760604889,
      "gmtModified": 1760604889,
      "resourceOwnerId": "15097**********",
      "alias": "alias",
      "extras": {
        "key": "{\"networkName\":\"hms\",\"metastoreUrl\":\"thrift://master-1-1.c-70*********.cn-hangzhou.emr.aliyuncs.com:9083\",\"keytabPath\":\"oss://********/hive.keytab\",\"principal\":\"hive/master-1-1.c-70****************\"}"
      }
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "totalCount": 200,
  "maxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.