All Products
Search

This Product

    E-MapReduce:CreateSessionCluster

    Document Center

    E-MapReduce:CreateSessionCluster

    Last Updated:Dec 01, 2025

    Creates a session cluster.

    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 body.

    queueName

    string

    No

    The queue name.

    root_queue
    autoStartConfiguration

    object

    No

    The automatic startup configuration.

    • true: Yes.

    • false: No.

    enable

    boolean

    No

    Specifies whether to enable automatic startup.

    • true: Enables automatic startup.

    • false: Disables automatic startup.

    false
    autoStopConfiguration

    object

    No

    The automatic stop configuration.

    enable

    boolean

    No

    Specifies whether to enable automatic stop.

    • true: Enables automatic stop.

    • false: Disables automatic stop.

    false
    idleTimeoutMinutes

    integer

    No

    The idle timeout period of the session. The session is automatically stopped after it is idle for the specified period. Unit: minutes.

    60
    applicationConfigs

    array<object>

    No

    The Spark application configurations.

    object

    No

    A Spark application configuration.

    configFileName

    string

    No

    The name of the configuration file.

    spark-defaults.conf

    configItemKey

    string

    No

    The key of a Spark configuration item.

    spark.app.name
    configItemValue

    string

    No

    The value of a Spark configuration item.

    test
    releaseVersion

    string

    No

    The version of the Spark engine.

    esr-3.3.1
    name

    string

    No

    The name of the task.

    spark_job_name
    kind

    string

    No

    The type of the session. Valid values:

    • SQL: an SQL session.

    • NOTEBOOK: a Notebook session.

    SQL
    displayReleaseVersion

    string

    No

    The version that is displayed in the console.

    esr-3.3.1

    fusion

    boolean

    No

    Specifies whether to enable the Fusion engine for acceleration.

    false
    envId

    string

    No

    The ID of the Python environment. This parameter applies only to Notebook sessions.

    env-cpv569tlhtgndjl86t40
    publicEndpointEnabled

    boolean

    No

    clientToken

    string

    No

    regionId

    string

    No

    The region ID.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    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.