All Products
Search
Document Center

E-MapReduce:GetKyuubiToken

Last Updated:Apr 21, 2026

Obtains an authentication token for 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:GetKyuubiToken

get

*All Resource

*

None None

Request syntax

GET /api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

No

The workspace ID.

w-d2d82aa09155****

kyuubiServiceId

string

No

The Kyuubi service ID.

kb-c7141f10c3f549fc9f8b8ae562b8****

tokenId

string

No

The token ID.

tk-zpi0*****hdv4y

Request parameters

Parameter

Type

Required

Description

Example

regionId

string

No

The region ID.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The data structure of the response.

requestId

string

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944****

data

object

The response data.

tokenId

string

The token ID.

tk-zpi0*****hdv4y

name

string

The token name.

dev_serverless_spark

token

string

The masked token.

dxj**********wfg

createdBy

string

The creator name.

admin

createTime

integer

The creation time.

1749456094000

expireTime

integer

The expiration time.

1753932319390

lastUsedTime

integer

The last used time.

1749456098000

autoExpireConfiguration

object

The automatic expiration configuration.

enable

boolean

Indicates whether the token automatically expires.

true

expireDays

integer

The expiration period, in days.

365

memberArns

array

The Alibaba Cloud Resource Names (ARNs) of the authorized users.

string

The ARN of the authorized user.

acs:emr::w-d2d82aa09155****:member/195****7311

sparkRole

array

string

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "data": {
    "tokenId": "tk-zpi0*****hdv4y",
    "name": "dev_serverless_spark\n",
    "token": "dxj**********wfg\n",
    "createdBy": "admin",
    "createTime": 1749456094000,
    "expireTime": 1753932319390,
    "lastUsedTime": 1749456098000,
    "autoExpireConfiguration": {
      "enable": true,
      "expireDays": 365
    },
    "memberArns": [
      "acs:emr::w-d2d82aa09155****:member/195****7311"
    ],
    "sparkRole": [
      ""
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.