All Products
Search
Document Center

DataWorks:CreateServerIdeInstance

Last Updated:Sep 29, 2026

Creates a personal development environment instance.

Operation description

Creates a personal development environment (ServerIDE) instance. After you specify the DataWorks workspace, resource group, image, and specifications, the instance is created and the instance ID is returned.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

Yes

The DataWorks workspace ID.

10000

ResourceGroupId

string

Yes

The DataWorks resource group identifier. You can specify the numeric ID of the resource group or the full identifier in the Serverless_res_group_{tenantId}_{resgId} format.

Serverless_res_group_123456789012345_9876543210****

Cu

integer

No

The number of CUs used by the instance.

10

Owner

string

No

The Alibaba Cloud account ID of the user who owns the instance. If this parameter is not specified, the current caller is used by default.

20933221576142****

ImageId

string

No

The image ID. You can call ListServerIdeImages to obtain the image ID.

System_serveride_notebook_20240822

ImageUrl

string

No

The image URL. This parameter is required when you use a non-official DataWorks image.

registry.cn-hangzhou.aliyuncs.com/example/serveride:latest

InstanceName

string

Yes

The name of the personal development environment instance.

notebook_dev

UserVpc

object

No

The Virtual Private Cloud (VPC) configuration used by the instance.

SecurityGroupId

string

No

The security group ID.

sg-bp1****

VSwitchId

string

No

The vSwitch ID.

vsw-bp1****

VpcId

string

No

The VPC ID.

vpc-bp1****

ForwardInfos

array<object>

No

The list of port forwarding configurations.

object

No

The port forwarding configuration.

AccessType

array

No

The list of access types.

string

No

The access type. Valid values:

  • intranet: internal network.

  • internet: public network.

intranet

ContainerName

string

No

The name of the target container.

dsw-notebook

Enable

boolean

No

Specifies whether to enable this port forwarding configuration.

true

ForwardPort

string

No

The target port in the instance container.

22

Name

string

No

The name of the port forwarding configuration.

ssh

NatGatewayId

string

No

The NAT gateway ID.

ngw-bp1****

SSHPublicKey

string

No

The public key used for SSH access.

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****

EipAllocationId

string

No

The instance ID of the public Elastic IP Address (EIP).

eip-bp1****

ExternalPort

string

No

The mapped public port.

1024

Datasets

array<object>

No

The list of datasets mounted to the instance.

object

No

The dataset mount configuration.

Identifier

string

No

The dataset identifier.

d-vsqjvs****rp5l206u

Version

integer

No

The dataset version number.

1

MountPath

string

No

The mount path of the dataset in the instance.

/mnt/data

ReadOnly

boolean

No

Specifies whether to mount the dataset in read-only mode.

false

ExtOptions

string

No

The custom mount properties of the dataset. The content is passed as mount options.

{"fs.oss.download.thread.concurrency":"10"}

Uri

string

No

The URI of the storage service directory for direct mounting.

oss://example-bucket/data/

CredentialConfig

object

No

The credential injection configuration for the instance. After this feature is enabled, you can use the default RAM role chain or specify a custom RAM role.

Enable

boolean

No

Specifies whether to enable credential injection.

True

AliyunEnvRoleKey

string

No

The environment variable role key.

0

Configs

array<object>

No

The list of credential configurations.

array<object>

No

The credential configuration.

Key

string

No

The identifier key of the credential configuration.

0

Type

string

No

The credential configuration type. Valid values:

  • Role: single role assumption.

  • RoleChain: role chain assumption.

RoleChain

Roles

array<object>

No

The list of roles in the credential configuration.

array<object>

No

The role assumption configuration.

AssumeRoleFor

string

No

The Alibaba Cloud account ID of the principal that owns the role to be assumed.

123456789012****

Policy

string

No

The policy used to further restrict the permissions of the role.

{}

RoleArn

string

No

The Alibaba Cloud Resource Name (ARN) of the RAM role.

acs:ram::123456789012****:role/DataWorksRole

RoleType

string

No

The role assumption type. Valid values:

  • service: assumed by a service.

  • user: assumed by a user.

service

UserInfo

object

No

The information about the proxied user.

Id

string

No

The account ID of the proxied user.

20933221576142****

Type

string

No

The user type. Valid values:

  • customer: Alibaba Cloud account.

  • sub: RAM user.

  • AssumedRoleUser: RAM role.

sub

UserCommand

object

No

The user command configuration to be executed when the instance starts.

OnStart

object

No

The command configuration to be executed after the instance starts.

Content

string

No

The command content to be executed after the instance starts. The maximum length is 1024 characters.

echo "serveride ready"

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

E7D55162-4489-1619-AAF5-3F97D5FCA948

InstanceId

string

The ID of the personal development environment instance.

699573

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "InstanceId": "699573"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.