ListKyuubiServices - E-MapReduce - Alibaba Cloud Documentation Center

Lists Kyuubi Gateways.

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

none

*All Resource

*

None

Request syntax

GET /api/v1/kyuubi/{workspaceId} 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

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
data	object	The returned data.
kyuubiServices	array<object>	A list of Kyuubi servers.
	object	A Kyuubi server record.
kyuubiConfigs	string	The Kyuubi server configurations.	kyuubi.conf.key=value1 kyuubi.conf.key1=value2
sparkConfigs	string	The default configurations for Spark applications launched by the Kyuubi server.	spark.conf.key=value1 spark.conf.key1=value2
state	string	The status of the Kyuubi server.	Running
name	string	The name of the Kyuubi server.	test
queue	string	The queue name.	dev_queue
createTime	string	The time when the server was created.	2025-03-11T08:21:58Z
startTime	string	The time when the Kyuubi server was last started.	2024-11-23 09:22:00
creator	string	The UID of the user who created the server.	103*******
kyuubiServiceId	string	The Kyuubi server ID.	kb-070104e7631242448d12a1377c309f30
innerEndpoint	string	The internal endpoint.	kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com
publicEndpoint	string	The public endpoint.	emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com
releaseVersion	string	The version number of the Spark engine.	esr-4.2.0 (Spark 3.5.2, Scala 2.12)
computeInstance	string	The instance type of the Kyuubi server.	4C16G
replica	integer	The number of replicas for the Kyuubi server.	3
kyuubiReleaseVersion	string	The version of the Kyuubi server.	1.9.2-0.0.1

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "data": {
    "kyuubiServices": [
      {
        "kyuubiConfigs": "kyuubi.conf.key=value1\nkyuubi.conf.key1=value2",
        "sparkConfigs": "spark.conf.key=value1\nspark.conf.key1=value2",
        "state": "Running",
        "name": "test",
        "queue": "dev_queue",
        "createTime": "2025-03-11T08:21:58Z",
        "startTime": "2024-11-23 09:22:00",
        "creator": "103*******",
        "kyuubiServiceId": "kb-070104e7631242448d12a1377c309f30",
        "innerEndpoint": "kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com",
        "publicEndpoint": "emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com",
        "releaseVersion": "esr-4.2.0 (Spark 3.5.2, Scala 2.12)\n",
        "computeInstance": "4C16G",
        "replica": 3,
        "kyuubiReleaseVersion": "1.9.2-0.0.1"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.