ListServerIdeInstances - DataWorks - Alibaba Cloud Documentation Center

Mengkueri daftar terpaginasi instans lingkungan pengembangan pribadi.

Deskripsi operasi

Mengkueri daftar kueri terpaginasi instans lingkungan pengembangan pribadi (ServerIDE) dengan paginasi. Anda dapat memfilter hasil berdasarkan ruang kerja, kelompok sumber daya, kata kunci, pemilik, dan subkelas instans.

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
ProjectId	integer	No	ID ruang kerja DataWorks.	10000
ResourceGroupId	string	No	Pengidentifikasi kelompok sumber daya DataWorks. Anda dapat menentukan ID kelompok sumber daya numerik atau pengidentifikasi lengkap dalam format Serverless_res_group_{tenantId}_{resgId}.	Serverless_res_group_123456789012345_9876543210****
Keyword	string	No	Kata kunci untuk pencocokan kabur berdasarkan ID instans atau nama instans.	notebook_dev
RelatedUserId	string	No	ID akun pengguna yang memiliki instans. Digunakan untuk memfilter instans berdasarkan pemilik.	20933221576142****
SubType	string	No	Subtipe instans. Nilai valid: PERSONAL_DEV: lingkungan pengembangan pribadi. DATA_AGENT: Data Agent.	PERSONAL_DEV
PageNumber	integer	No	Nomor halaman. Nilai minimum: 1.	1
PageSize	integer	No	Jumlah rekaman per halaman.	10
MaxResults	integer	No	Jumlah maksimum rekaman yang dikembalikan dalam satu permintaan.	20
NextToken	string	No	Token paginasi untuk kueri berikutnya. Anda tidak perlu menentukan parameter ini untuk permintaan pertama.	CAESG****

Elemen respons

Element	Type	Description	Example
	object	Tanggapan.
RequestId	string	ID permintaan.	E7D55162-4489-1619-AAF5-3F97D5FCA948
PagingInfo	object	Informasi paginasi.
PageNumber	integer	Nomor halaman saat ini.	1
PageSize	integer	Jumlah rekaman per halaman.	10
TotalCount	integer	Jumlah total rekaman yang sesuai dengan kondisi filter.	3
Instances	array<object>	Daftar instans lingkungan pengembangan pribadi.
	array<object>	Informasi 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 memasuki status gagal.	ImagePullBackOff
CreateTime	integer	Waktu instans dibuat. Nilainya adalah stempel waktu UNIX dalam milidetik.	1756000000000
UpdateTime	integer	Waktu instans terakhir diperbarui. Nilainya 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. internet: jaringan publik.	intranet
ContainerName	string	Nama kontainer target.	dsw-notebook
EipAllocationId	string	ID instans elastic IP address (EIP).	eip-bp1****
Enable	boolean	Apakah konfigurasi penerusan port diaktifkan.
ExternalPort	string	Port publik yang dipetakan.	1024
ForwardPort	string	Port target 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 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. 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 entitas yang memiliki peran yang akan diasumsikan.	123456789012****
Policy	string	Kebijakan yang digunakan untuk membatasi lebih lanjut izin peran.	{}
RoleArn	string	Nama Sumber Daya Alibaba Cloud (ARN) dari peran RAM.	acs:ram::123456789012****:role/DataWorksRole
RoleType	string	Tipe asumsi peran. Nilai valid: service: Diasumsikan oleh layanan. user: Diasumsikan oleh pengguna.	service
UserInfo	object	Informasi tentang pengguna yang didelegasikan.
AccessKeyId	string	ID AccessKey sementara yang digunakan untuk injeksi kredensial.	STS.N*********7
Id	string	ID akun pengguna yang didelegasikan.	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. AssumedRoleUser: Peran RAM.	sub
MaxResults	integer	Jumlah maksimum rekaman yang dikembalikan dalam tanggapan ini.	20
NextToken	string	Token paginasi untuk halaman berikutnya. Nilai kosong menunjukkan bahwa tidak ada hasil lagi yang tersedia.	CAESG****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 3,
    "Instances": [
      {
        "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"
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  },
  "MaxResults": 20,
  "NextToken": "CAESG****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.