GetLivyComputeToken - E-MapReduce - Alibaba Cloud Documentation Center

Retrieves the token for a Livy 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:GetLivyComputeToken

get

*All Resource

*

None

Request syntax

GET /api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceBizId	string	No	The workspace ID.	w-8adde60aa809701f
livyComputeId	string	No	The ID of the Livy Gateway.	lc-6mkvn01zrg8rqhhv
tokenId	string	No	Token ID。	lctk-xxxxxxxx

Request parameters

Parameter	Type	Required	Description	Example
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	484D9DDA-300D-525E-AF7A-0CCCA5C64A7A
code	string	The return code of the request. A value of 1000000 indicates that the request succeeded. Other values indicate that the request failed. For details about the error, see the message field.	1000000
message	string	The response message.	ok
data	object	The returned data.
tokenId	string	Token ID。	lctk-xxxxxxxxxx
name	string	The token name.	test
token	string	The token content.	d25561157a635bb
createdBy	string	The name of the creator.	alice
createTime	integer	The creation time. The value is a UNIX timestamp in milliseconds.	1749456094000
expireTime	integer	The expiration time. The value is a UNIX timestamp in milliseconds.	1749457994000
lastUsedTime	integer	The last used time. The value is a UNIX timestamp in milliseconds.	1749456098000
autoExpireConfiguration	object	The token expiration configuration struct.
enable	boolean	Specifies whether the token expires automatically. Valid values: true: Yes. false: No.	false
expireDays	integer	The expiration period in days.	7

Examples

Success response

JSON format

{
  "requestId": "484D9DDA-300D-525E-AF7A-0CCCA5C64A7A",
  "code": "1000000",
  "message": "ok",
  "data": {
    "tokenId": "lctk-xxxxxxxxxx",
    "name": "test",
    "token": "d25561157a635bb",
    "createdBy": "alice",
    "createTime": 1749456094000,
    "expireTime": 1749457994000,
    "lastUsedTime": 1749456098000,
    "autoExpireConfiguration": {
      "enable": false,
      "expireDays": 7
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.