All Products
Search
Document Center

DataWorks:GetServerIdeInstance

Last Updated:Sep 29, 2026

Queries the details of a specified personal development environment instance.

Operation description

Queries the basic information, running status, image, network, dataset, and credential configurations of a specified personal development environment (ServerIDE) instance.

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

InstanceId

string

Yes

The personal development environment instance ID. You can call ListServerIdeInstances to obtain the ID.

699573

Response elements

Element

Type

Description

Example

object

The response.

RequestId

string

The request ID.

E7D55162-4489-1619-AAF5-3F97D5FCA948

Instance

object

The details of the personal development environment instance.

InstanceId

string

The personal development environment instance ID.

699573

InstanceName

string

The name of the personal development environment instance.

notebook_dev

Status

string

The instance status. Valid values: Creating, Starting, Running, Stopping, Stopped, Updating, Deleting, DELETED, Failed, Arrearage, Saving, SaveFailed, and Saved.

Running

ResourceGroupId

integer

The internal numeric ID of the resource group.

9876543210

ResourceGroupName

string

The resource group name.

serverless_group

Cu

integer

The number of CUs used by the instance.

10

ProjectId

integer

The DataWorks workspace ID.

10000

ProjectName

string

The DataWorks workspace name.

example_project

ImageId

string

The ID of the image used by the instance.

System_serveride_notebook_20240822

ImageName

string

The image name.

serveride_notebook

ImageUrl

string

The image URL.

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

OwnerId

string

The account ID of the user who owns the instance.

20933221576142****

FailReason

string

The reason why the instance entered the failed state.

ImagePullBackOff

CreateTime

integer

The time when the instance was created. This value is a UNIX timestamp in milliseconds.

1756000000000

UpdateTime

integer

The time when the instance was last updated. This value is a UNIX timestamp in milliseconds.

1756003600000

UserVpc

object

The VPC configuration used by the instance.

SecurityGroupId

string

The security group ID.

sg-bp1****

VSwitchId

string

The vSwitch ID.

vsw-bp1****

VpcId

string

The VPC ID.

vpc-bp1****

ForwardInfos

array<object>

The list of port forwarding configurations.

object

The port forwarding configuration.

AccessType

array

The list of access types.

string

The access type. Valid values: intranet (internal network) and internet (public network).

intranet

ContainerName

string

The name of the target container.

dsw-notebook

EipAllocationId

string

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

eip-bp1****

Enable

boolean

Indicates whether this port forwarding configuration is enabled.

ExternalPort

string

The mapped public port.

1024

ForwardPort

string

The target port inside the instance container.

22

Name

string

The name of the port forwarding configuration.

ssh

NatGatewayId

string

The NAT gateway ID.

ngw-bp1****

SSHPublicKey

string

The public key used for SSH access.

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****

Datasets

array<object>

The list of datasets mounted to the instance.

object

The dataset mount configuration.

Identifier

string

The dataset identifier.

d-vsqjvs****rp5l206u

Version

integer

The dataset version number.

1

MountPath

string

The mount path of the dataset in the instance.

/mnt/data

ReadOnly

boolean

Indicates whether the dataset is mounted in read-only mode.

ExtOptions

string

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

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

Uri

string

The URI of the storage service directory used for direct mounting.

oss://example-bucket/data/

CredentialConfig

object

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

Enable

boolean

Indicates whether credential injection is enabled.

AliyunEnvRoleKey

string

The environment variable role key.

0

Configs

array<object>

The list of credential configurations.

array<object>

The credential configuration.

Key

string

The identifier key of the credential configuration.

0

Type

string

The credential configuration type. Valid values: Role (single role assumption) and RoleChain (role chain assumption).

RoleChain

Roles

array<object>

The list of roles in the credential configuration.

array<object>

The role assumption configuration.

AssumeRoleFor

string

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

123456789012****

Policy

string

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

{}

RoleArn

string

The ARN of the RAM role.

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

RoleType

string

The role assumption type. Valid values: service (assumed by a service) and user (assumed by a user).

service

UserInfo

object

The information of the proxied user.

AccessKeyId

string

The temporary AccessKey ID used for credential injection.

STS.N*********7

Id

string

The account ID of the proxied user.

20933221576142****

SecurityToken

string

The temporary security token used for credential injection.

DFE32G*******

Type

string

The user type. Valid values: customer (Alibaba Cloud account), sub (RAM user), and AssumedRoleUser (RAM role).

sub

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Instance": {
    "InstanceId": "699573",
    "InstanceName": "notebook_dev",
    "Status": "Running",
    "ResourceGroupId": 9876543210,
    "ResourceGroupName": "serverless_group",
    "Cu": 10,
    "ProjectId": 10000,
    "ProjectName": "example_project",
    "ImageId": "System_serveride_notebook_20240822",
    "ImageName": "serveride_notebook",
    "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/example/serveride:latest",
    "OwnerId": "20933221576142****",
    "FailReason": "ImagePullBackOff",
    "CreateTime": 1756000000000,
    "UpdateTime": 1756003600000,
    "UserVpc": {
      "SecurityGroupId": "sg-bp1****",
      "VSwitchId": "vsw-bp1****",
      "VpcId": "vpc-bp1****",
      "ForwardInfos": [
        {
          "AccessType": [
            "intranet"
          ],
          "ContainerName": "dsw-notebook",
          "EipAllocationId": "eip-bp1****",
          "Enable": false,
          "ExternalPort": "1024",
          "ForwardPort": "22",
          "Name": "ssh",
          "NatGatewayId": "ngw-bp1****",
          "SSHPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****"
        }
      ]
    },
    "Datasets": [
      {
        "Identifier": "d-vsqjvs****rp5l206u",
        "Version": 1,
        "MountPath": "/mnt/data",
        "ReadOnly": false,
        "ExtOptions": "{\"fs.oss.download.thread.concurrency\":\"10\"}",
        "Uri": "oss://example-bucket/data/"
      }
    ],
    "CredentialConfig": {
      "Enable": false,
      "AliyunEnvRoleKey": "0",
      "Configs": [
        {
          "Key": "0",
          "Type": "RoleChain",
          "Roles": [
            {
              "AssumeRoleFor": "123456789012****",
              "Policy": "{}",
              "RoleArn": "acs:ram::123456789012****:role/DataWorksRole",
              "RoleType": "service",
              "UserInfo": {
                "AccessKeyId": "STS.N*********7",
                "Id": "20933221576142****",
                "SecurityToken": "DFE32G*******",
                "Type": "sub"
              }
            }
          ]
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.