DocsICP FilingConsole
Documentation

CreateSessionCluster

Updated at:
Copy as MD
Product
My Favorites

Creates a session.

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

create

*All Resource

*

 None None

Request syntax

POST /api/v1/workspaces/{workspaceId}/sessionClusters HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example
workspaceId

string

No

The workspace ID.

w-790b443d72394bfc

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request struct.

queueName

string

No

The queue name.

root_queue
autoStartConfiguration

object

No

Specifies whether to enable automatic startup. Valid values:

  • true: Enabled.

  • false: Disabled.

enable

boolean

No

Specifies whether to enable automatic startup. Valid values:

  • true: Enabled.

  • false: Disabled.

false
autoStopConfiguration

object

No

The automatic stop configuration.

enable

boolean

No

Specifies whether to allow automatic stop. Valid values:

  • true: Allowed.

  • false: Not allowed.

false
idleTimeoutMinutes

integer

No

The number of idle minutes after which the session is automatically stopped.

60
applicationConfigs

array<object>

No

The Spark application configurations.

object

No

The Spark application configurations.

configFileName

string

No

The configuration file name.

spark-defaults.conf

configItemKey

string

No

The Spark Conf key.

spark.app.name
configItemValue

string

No

The Spark Conf value.

test
releaseVersion

string

No

The Spark DPI engine version number.

esr-3.3.1
name

string

No

The node name.

spark_job_name
kind

string

No

The session type. Valid values:

  • SQL: SQL session.

  • NOTEBOOK: NOTEBOOK session.

SQL
displayReleaseVersion

string

No

The version displayed in the console.

esr-3.3.1

fusion

boolean

No

Specifies whether to enable Fusion engine acceleration.

false
envId

string

No

The Python environment ID. This parameter takes effect only for Notebook sessions.

env-cpv569tlhtgndjl86t40
publicEndpointEnabled

boolean

No

Specifies whether to enable the public network access endpoint.

false
clientToken

string

No

The client token that is used to ensure the idempotence of the request.

my-token-asxkxxxxxxx
regionId

string

No

The region ID.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response data.

sessionClusterId

string

The session ID.

w-******
requestId

string

The request ID.

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

Examples

Success response

JSON format

{
  "sessionClusterId": "w-******",
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.