All Products
Search
Document Center

DataWorks:GetServerIdeInstance

Last Updated:Aug 25, 2026

Mengkueri detail instans lingkungan pengembangan pribadi tertentu.

Deskripsi operasi

Mengkueri informasi dasar, status berjalan, image, jaringan, set data, dan konfigurasi kredensial dari instans lingkungan pengembangan pribadi (ServerIDE) tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

ID instans lingkungan pengembangan pribadi. Anda dapat memanggil ListServerIdeInstances untuk mendapatkan ID tersebut.

699573

Elemen respons

Element

Type

Description

Example

object

Tanggapan.

RequestId

string

ID permintaan.

E7D55162-4489-1619-AAF5-3F97D5FCA948

Instance

object

Detail instans lingkungan pengembangan pribadi.

InstanceId

string

ID instans lingkungan pengembangan pribadi.

699573

InstanceName

string

Nama instans lingkungan pengembangan pribadi.

notebook_dev

Status

string

Status instans. Nilai valid: Creating, Starting, Running, Stopping, Stopped, Updating, Deleting, DELETED, Failed, Arrearage, Saving, SaveFailed, dan Saved.

Running

ResourceGroupId

integer

ID numerik internal kelompok sumber daya.

9876543210

ResourceGroupName

string

Nama kelompok sumber daya.

serverless_kelompok

Cu

integer

Jumlah CU yang digunakan oleh instans.

10

ProjectId

integer

ID ruang kerja DataWorks.

10000

ProjectName

string

Nama ruang kerja DataWorks.

example_project

ImageId

string

ID image yang digunakan oleh instans.

System_serveride_notebook_20240822

ImageName

string

Nama image.

serveride_notebook

ImageUrl

string

URL image.

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

OwnerId

string

ID akun pengguna yang memiliki instans.

20933221576142****

FailReason

string

Alasan instans masuk ke status gagal.

ImagePullBackOff

CreateTime

integer

Pengatur waktu saat instans dibuat. Nilai ini adalah stempel waktu UNIX dalam milidetik.

1756000000000

UpdateTime

integer

Pengatur waktu saat instans terakhir diperbarui. Nilai ini adalah stempel waktu UNIX dalam milidetik.

1756003600000

UserVpc

object

Konfigurasi VPC yang digunakan oleh instans.

SecurityGroupId

string

ID grup keamanan.

sg-bp1****

VSwitchId

string

ID vSwitch.

vsw-bp1****

VpcId

string

ID VPC.

vpc-bp1****

ForwardInfos

array<object>

Daftar konfigurasi penerusan port.

object

Konfigurasi penerusan port.

AccessType

array

Daftar tipe akses.

string

Tipe akses. Nilai valid: intranet (jaringan internal) dan internet (jaringan publik).

intranet

ContainerName

string

Nama kontainer target.

dsw-notebook

EipAllocationId

string

ID instans Elastic IP Address (EIP) publik.

eip-bp1****

Enable

boolean

Apakah konfigurasi penerusan port ini diaktifkan.

ExternalPort

string

Port publik yang dipetakan.

1024

ForwardPort

string

Port target di dalam kontainer instans.

22

Name

string

Nama konfigurasi penerusan port.

ssh

NatGatewayId

string

ID gerbang NAT.

ngw-bp1****

SSHPublicKey

string

Kunci publik yang digunakan untuk akses SSH.

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****

Datasets

array<object>

Daftar set data yang dipasang ke instans.

object

Konfigurasi pemasangan set data.

Identifier

string

Pengenal set data.

d-vsqjvs****rp5l206u

Version

integer

Nomor versi set data.

1

MountPath

string

Jalur pemasangan set data di instans.

/mnt/data

ReadOnly

boolean

Apakah set data dipasang dalam mode baca-saja.

ExtOptions

string

Properti pemasangan kustom set data. Konten diteruskan sebagai opsi pemasangan.

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

Uri

string

URI direktori layanan penyimpanan yang digunakan untuk pemasangan langsung.

oss://example-bucket/data/

CredentialConfig

object

Konfigurasi injeksi kredensial instans. Setelah fitur ini diaktifkan, Anda dapat menggunakan rantai peran RAM default atau menentukan peran RAM kustom.

Enable

boolean

Apakah injeksi kredensial diaktifkan.

AliyunEnvRoleKey

string

Kunci peran variabel lingkungan.

0

Configs

array<object>

Daftar konfigurasi kredensial.

array<object>

Konfigurasi kredensial.

Key

string

Kunci pengenal konfigurasi kredensial.

0

Type

string

Tipe konfigurasi kredensial. Nilai valid: Role (asumsi peran tunggal) dan RoleChain (asumsi rantai peran).

RoleChain

Roles

array<object>

Daftar peran dalam konfigurasi kredensial.

array<object>

Konfigurasi asumsi peran.

AssumeRoleFor

string

ID akun Alibaba Cloud dari pihak yang berwenang yang memiliki peran yang diasumsikan.

123456789012****

Policy

string

Kebijakan yang digunakan untuk membatasi lebih lanjut izin peran.

{}

RoleArn

string

ARN peran RAM.

acs:ram::123456789012****:peran/DataWorksRole

RoleType

string

Tipe asumsi peran. Nilai valid: service (diasumsikan oleh layanan) dan user (diasumsikan oleh pengguna).

layanan

UserInfo

object

Informasi pengguna yang diproksikan.

AccessKeyId

string

ID AccessKey sementara yang digunakan untuk injeksi kredensial.

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

Id

string

ID akun pengguna yang diproksikan.

20933221576142****

SecurityToken

string

Token keamanan sementara yang digunakan untuk injeksi kredensial.

DFE32G*******

Type

string

Tipe pengguna. Nilai valid: customer (akun Alibaba Cloud), sub (pengguna RAM), dan AssumedRoleUser (peran RAM).

sub

Contoh

Respons sukses

JSONformat

{
  "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"
              }
            }
          ]
        }
      ]
    }
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.