GetKyuubiService API Reference for Kyuubi Gateway - E-MapReduce - Alibaba Cloud - E-MapReduce

Retrieves a Kyuubi Gateway.

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

none

*All Resource

*

None

Request syntax

GET /api/v1/kyuubi/{workspaceId}/{kyuubiServiceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-cea2c314a****
kyuubiServiceId	string	No	The Kyuubi service ID.	kb-415ddee******f1d1eac0388b86

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response struct.
requestId	string	The request ID.	8CE06D75-E6A2-505D-9B4B-31DEE3D98A04
data	object	The returned result.
kyuubiConfigs	string	The Kyuubi service configuration.	[]
sparkConfigs	string	The Spark configuration.	[]
state	string	The Kyuubi service status.	RUNNING
name	string	The Kyuubi service name.	dev_serverless_spark
queue	string	The queue name.	dev_queue
createTime	string	The creation time. The value is a UNIX timestamp in milliseconds.	1749456094000
startTime	string	The start time. The value is a UNIX timestamp in milliseconds.	1749456094000
creator	string	The UID of the creator.	150978934701****
kyuubiServiceId	string	Kyuubi Service ID。	kb-4e209b04588***95f04ad3538ae4
innerEndpoint	string	The internal network domain name.	kyuubi-cn-beijing-internal.spark.emr.aliyuncs.com
publicEndpoint	string	The public domain name.	emr-spark-kyuubi-gateway-cn-beijing.aliyuncs.com
releaseVersion	string	The Spark DPI engine version.	esr-4.6.0 (Spark 3.5.2, Scala 2.12)
computeInstance	string	The Kyuubi service specifications.	2c8g
publicEndpointEnabled	boolean	Specifies whether public network access is enabled.	true
replica	integer	The number of replicas enabled for high availability.	0
kyuubiReleaseVersion	string	The Kyuubi service DPI engine version.	1.9.2-0.0.2

Examples

Success response

JSON format

{
  "requestId": "8CE06D75-E6A2-505D-9B4B-31DEE3D98A04",
  "data": {
    "kyuubiConfigs": "[]",
    "sparkConfigs": "[]",
    "state": "RUNNING",
    "name": "dev_serverless_spark\n",
    "queue": "dev_queue",
    "createTime": "1749456094000",
    "startTime": "1749456094000",
    "creator": "150978934701****",
    "kyuubiServiceId": "kb-4e209b04588***95f04ad3538ae4",
    "innerEndpoint": "kyuubi-cn-beijing-internal.spark.emr.aliyuncs.com",
    "publicEndpoint": "emr-spark-kyuubi-gateway-cn-beijing.aliyuncs.com",
    "releaseVersion": "esr-4.6.0 (Spark 3.5.2, Scala 2.12)",
    "computeInstance": "2c8g",
    "publicEndpointEnabled": true,
    "replica": 0,
    "kyuubiReleaseVersion": "1.9.2-0.0.2"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.