Gunakan API CreateDesktops untuk membuat cloud computer - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Membuat satu atau beberapa desktop cloud. Jika informasi pengguna ditentukan saat pembuatan, desktop cloud langsung ditetapkan kepada pengguna.

Deskripsi operasi

Sebelum membuat desktop cloud, selesaikan persiapan berikut:

Buat jaringan kantor (sebelumnya ruang kerja) dan pengguna. Untuk informasi lebih lanjut, lihat operasi API atau dokumentasi berikut:
- Jaringan kantor Convenience: CreateSimpleOfficeSite dan CreateUsers.
- Jaringan kantor AD: CreateADConnectorOfficeSite dan Membuat pengguna AD.
Panggil CreatePolicyGroup untuk membuat Kebijakan, atau konfirmasi bahwa Kebijakan yang ada tersedia.

Contoh panggilan:

Contoh pembuatan dengan templat

{
  "RegionId": "ap-southeast-1",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+dir-xxx",// Buat jaringan kantor terlebih dahulu
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "BundleId": "b-enterprise_office_8c16g_windows2022"
}

Contoh pembuatan tanpa templat

{
  "RegionId": "ap-southeast-1",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+dir-xxx",// Buat jaringan kantor terlebih dahulu
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "ImageId": "desktopimage-windows-server-2022-64-asp",
    "SystemDiskSize": "40",
    "DataDiskSize": "0",
    "DefaultLanguage": "zh-CN",
    "DesktopType": "eds.enterprise_office.4c8g"
  }
}

Contoh pembuatan paket bulanan per jam

{
  "RegionId": "ap-southeast-1",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+dir-xxx",// Buat jaringan kantor terlebih dahulu
  "PolicyGroupId": "system-all-enabled-policy",
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "ImageId": "desktopimage-windows-server-2022-64-asp",
    "SystemDiskSize": "40",
    "DataDiskSize": "0",
    "DefaultLanguage": "zh-CN",
    "DesktopType": "eds.enterprise_office.4c8g"
  },
  "MonthDesktopSetting": {
    "UseDuration": "120"
  },
  "Period": "1",
  "PeriodUnit": "Month"
}

Contoh pembuatan Sumber daya Agen

{
  "RegionId": "ap-southeast-1",
  "BundleId": "b-openclaw-linux",
  "DesktopName": "test-desktop-name",
  "Amount": "1",
  "OfficeSiteId": "ap-southeast-1+dir-xxx",// Buat jaringan kantor terlebih dahulu
  "ChargeType": "PostPaid",
  "DesktopAttachment": {
    "DesktopType": "cloud.space.4c.8g"
  },
  "PurchaseOptions": {
    "MonthlyCredits": "120"
  },
  "Period": "1",
  "PeriodUnit": "Month"
}

Agar desktop cloud secara otomatis menjalankan skrip perintah kustom, gunakan bidang UserCommands untuk mengonfigurasi perintah kustom.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateDesktops

create

*Semua resource.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri wilayah yang didukung oleh WUYING Workspace.	cn-hangzhou
GroupId	string	No	ID pool desktop cloud.	dg-boyczi8enfyc5****
BundleId	string	No	ID templat desktop cloud. Jika ID templat tidak ditentukan, Anda dapat membuat desktop cloud dengan menentukan bidang yang diperlukan.	b-je9hani001wfn****
DesktopName	string	No	Nama desktop cloud. Aturan penamaannya adalah sebagai berikut: Panjang nama maksimal 64 karakter. Nama harus dimulai dengan huruf atau karakter Mandarin dan tidak boleh dimulai dengan `http://` atau `https://`. Nama dapat berisi karakter Mandarin, huruf, digit, titik dua (:), garis bawah (_), titik (.), atau tanda hubung (-).	DemoComputer01
UserName	string	No	Catatan Parameter ini tidak tersedia untuk digunakan.	username
VpcId	string	No	Catatan Parameter ini tidak tersedia untuk digunakan.	vpc-uf6w8u60n8xbkg5el****
Amount	integer	No	Jumlah desktop cloud yang akan dibuat. Nilai valid: 1 hingga 300. Nilai default: 1.	1
DirectoryId	string	No	Catatan Parameter ini tidak tersedia untuk digunakan.	cn-hangzhou+dir-300943****
OfficeSiteId	string	No	ID jaringan kantor.	cn-hangzhou+dir-387822****
PolicyGroupId	string	No	ID kebijakan.	system-all-enabled-policy
ChargeType	string	No	Metode penagihan desktop cloud. Valid values: PostPaid : bayar sesuai pemakaian [default] PrePaid : langganan.	PrePaid
Period	integer	No	Durasi langganan Sumber daya. Satuan ditentukan oleh `PeriodUnit`. Parameter ini berlaku dan diperlukan hanya jika `ChargeType` diatur ke `PrePaid`. Jika `PeriodUnit` diatur ke `Month`, nilai valid parameter ini: 1 2 3 6 Jika `PeriodUnit` diatur ke `Year`, nilai valid parameter ini: 1 2 3 4 5	1
PeriodUnit	string	No	Satuan durasi langganan. Valid values: Month : bulan [default] Year : tahun.	Month
AutoPay	boolean	No	Apakah akan mengaktifkan pembayaran otomatis. Valid values: true : Pembayaran otomatis diaktifkan. Pastikan saldo akun Anda mencukupi. Jika tidak, pesanan abnormal akan dihasilkan. [default] false : Pesanan dibuat tetapi belum dibayar. Anda dapat masuk ke konsol dan membuka halaman Pesanan di Pusat Pengguna untuk menyelesaikan pembayaran berdasarkan ID pesanan yang dikembalikan.	false
AutoRenew	boolean	No	Apakah akan mengaktifkan perpanjangan otomatis. Parameter ini berlaku hanya jika `ChargeType` diatur ke `PrePaid`. Valid values: true : Perpanjangan otomatis diaktifkan. Durasi perpanjangan sama dengan durasi langganan. false : Perpanjangan otomatis dinonaktifkan. [default]	false
PromotionId	string	No	ID promosi.	23141
UserAssignMode	string	No	Mode penetapan desktop cloud. Catatan Jika `EndUserId` tidak ditentukan, desktop cloud yang dibuat tidak ditetapkan kepada pengguna mana pun. Valid values: ALL : Jika EndUserId ditentukan, desktop cloud yang dibuat ditetapkan kepada setiap pengguna yang ditentukan. [default] PER_USER : Jika EndUserId ditentukan, desktop cloud yang dibuat didistribusikan secara merata di antara pengguna yang ditentukan. Nilai Amount harus habis dibagi dengan jumlah nilai EndUserId (N).	ALL
Hostname	string	No	Hostname kustom desktop cloud. Pengaturan untuk parameter ini hanya didukung untuk desktop cloud yang menjalankan sistem operasi Windows di jaringan kantor AD. Aturan penamaan untuk hostname adalah sebagai berikut: Panjang hostname harus 2 hingga 15 karakter. Hostname dapat berisi huruf besar, huruf kecil, digit, atau tanda hubung (-). Tidak boleh dimulai atau diakhiri dengan tanda hubung, mengandung tanda hubung berurutan, atau hanya terdiri dari digit. Saat Anda membuat beberapa desktop cloud, Anda dapat menggunakan format `name_prefix[begin_number,bits]name_suffix` untuk menamai desktop cloud secara seragam. Misalnya, jika Anda mengatur Hostname ke ecd-[1,4]-test, hostname desktop cloud pertama adalah ecd-0001-test, hostname desktop cloud kedua adalah ecd-0002-test, dan seterusnya. `name_prefix`: awalan hostname. `[begin_number,bits]`: nomor urut dalam hostname. `begin_number` adalah nomor awal. Nilai valid: 0 hingga 999999. Nilai default: 0. `bits` adalah jumlah digit. Nilai valid: 1 hingga 6. Nilai default: 6. `name_suffix`: akhiran hostname.	testhost
EndUserId	array	No	Daftar ID pengguna yang diberi otorisasi untuk ditambahkan ke desktop cloud. Anda dapat menentukan 1 hingga 100 ID pengguna.	123456789
	string	No	ID pengguna yang diberi otorisasi untuk ditambahkan ke desktop cloud. Hanya satu pengguna yang dapat menggunakan desktop cloud pada satu waktu. Jika `EndUserId` tidak ditentukan, desktop cloud yang dibuat tidak ditetapkan kepada pengguna mana pun.	alice
Tag	array<object>	No	Tag.
	object	No	Tag.
Key	string	No	Kunci tag. Anda dapat menentukan 1 hingga 20 kunci tag.	TestKey
Value	string	No	Nilai tag. Anda dapat menentukan 1 hingga 20 nilai tag.	TestValue
DesktopNameSuffix	boolean	No	Apakah akan secara otomatis menambahkan akhiran ke nama desktop cloud saat Anda membuat beberapa desktop cloud dalam batch. Valid values: true : Akhiran ditambahkan secara otomatis. [default] false : Tidak ada akhiran yang ditambahkan.	false
VolumeEncryptionEnabled	boolean	No	Apakah akan mengaktifkan enkripsi disk. Valid values: true : Enkripsi disk diaktifkan. false : Enkripsi disk dinonaktifkan. [default]	false
VolumeEncryptionKey	string	No	ID kunci Key Management Service (KMS) yang digunakan untuk enkripsi disk. Anda dapat memanggil ListKeys untuk mendapatkan ID kunci.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DesktopMemberIp	string	No	Alamat IP privat desktop cloud.	10.0.0.1
UserCommands	array<object>	No	Data skrip perintah kustom.
	object	No	Data skrip perintah kustom.
ContentEncoding	string	No	Metode pengkodean konten perintah (CommandContent). Valid values: Base64 : Pengkodean Base64. PlainText : tanpa pengkodean, dikirimkan dalam teks biasa.	Base64
Content	string	No	Konten perintah.	bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****
ContentType	string	No	Jenis bahasa perintah. Valid values: RunPowerShellScript : Perintah PowerShell untuk instans Windows. RunShellScript : Perintah Shell untuk instans Linux. RunBatScript : Perintah Bat untuk instans Windows.	RunPowerShellScript
BundleModels	array<object>	No	Daftar templat desktop cloud.
	object	No	Templat desktop cloud.
BundleId	string	No	ID templat desktop cloud.	b-je9hani001wfn****
Amount	integer	No	Jumlah desktop cloud yang akan dibuat. Nilai valid: 1 hingga 300. Nilai default: 0.	1
EndUserIds	array	No	Daftar pengguna kepada siapa desktop cloud ditetapkan.
	string	No	Nama pengguna.	alice
DesktopName	string	No	Nama desktop cloud. Aturan penamaannya adalah sebagai berikut: Panjang nama maksimal 64 karakter. Nama harus dimulai dengan huruf atau karakter Mandarin dan tidak boleh dimulai dengan `http://` atau `https://`. Nama dapat berisi karakter Mandarin, huruf, digit, titik dua (:), garis bawah (_), titik (.), atau tanda hubung (-).	DemoComputer02
Hostname	string	No	Hostname kustom desktop cloud. Pengaturan untuk parameter ini hanya didukung untuk desktop cloud yang menjalankan sistem operasi Windows di jaringan kantor AD. Aturan penamaan untuk hostname adalah sebagai berikut: Panjang hostname harus 2 hingga 15 karakter. Hostname dapat berisi huruf besar, huruf kecil, digit, atau tanda hubung (-). Tidak boleh dimulai atau diakhiri dengan tanda hubung, mengandung tanda hubung berurutan, atau hanya terdiri dari digit. Saat Anda membuat beberapa desktop cloud, Anda dapat menggunakan format `name_prefix[begin_number,bits]name_suffix` untuk menamai desktop cloud secara seragam. Misalnya, jika Anda mengatur Hostname ke ecd-[1,4]-test, hostname desktop cloud pertama adalah ecd-0001-test, hostname desktop cloud kedua adalah ecd-0002-test, dan seterusnya. `name_prefix`: awalan hostname. `[begin_number,bits]`: nomor urut dalam hostname. `begin_number` adalah nomor awal. Nilai valid: 0 hingga 999999. Nilai default: 0. `bits` adalah jumlah digit. Nilai valid: 1 hingga 6. Nilai default: 6. `name_suffix`: akhiran hostname.	testhost
VolumeEncryptionEnabled	boolean	No	Apakah akan mengaktifkan enkripsi disk.	false
VolumeEncryptionKey	string	No	ID kunci Key Management Service (KMS) yang digunakan untuk enkripsi disk. Anda dapat memanggil ListKeys untuk mendapatkan ID kunci.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
DesktopTimers	array<object>	No	Detail tugas terjadwal desktop cloud. Parameter ini sedang didepresiasi. Gunakan parameter TimerGroupId sebagai gantinya.
	object	No	Detail tugas terjadwal desktop cloud.
TimerType	string	No	Tipe tugas terjadwal.	NoOperationReboot
CronExpression	string	No	Ekspresi cron tugas terjadwal. Penting Tentukan waktu dalam UTC. Misalnya, untuk menjadwalkan tugas pada pukul 00:00 (UTC+8) setiap hari, atur nilainya menjadi 0 0 16 ? * 1,2,3,4,5,6,7.	0 40 7 ? * 1,2,3,4,5,6,7
Interval	integer	No	Interval pengatur waktu, dalam menit.	10
Enforce	boolean	No	Apakah akan menjalankan tugas secara paksa. Valid values: true : Tugas terjadwal dijalankan secara paksa terlepas dari status desktop cloud atau status koneksi. false : Tugas tidak dijalankan secara paksa.	true
ResetType	string	No	Tipe reset desktop cloud. Valid values: RESET_TYPE_SYSTEM : Meriset cloud disk sistem. RESET_TYPE_BOTH : Meriset cloud disk sistem dan cloud disk pengguna.	RESET_TYPE_SYSTEM
OperationType	string	No	Tipe operasi tugas terjadwal. Saat ini, hanya tugas terjadwal pemutusan koneksi yang didukung. Valid values: Hibernate : hibernasi. Shutdown : matikan.	Shutdown
AllowClientSetting	boolean	No	Apakah akan mengizinkan pengguna akhir mengonfigurasi tugas terjadwal.	true
SubnetId	string	No	ID subnet.	vsw-bp1m*****
MonthDesktopSetting	object	No	Parameter pembelian untuk paket bulanan per jam.
UseDuration	integer	No	Opsi paket saat membeli paket bulanan per jam. Nilai valid: 120, 250, dan 360.	null
BuyerId	integer	No	Catatan Bidang ini tidak tersedia untuk digunakan.	null
DesktopId	string	No	Catatan Bidang ini tidak tersedia untuk digunakan.	null
SnapshotPolicyId	string	No	ID kebijakan snapshot otomatis WUYING.	sp-28mp6my0l6zow****
ResourceGroupId	string	No	ID kelompok sumber daya WUYING.	rg-3mtuc28rx95lx****
DesktopAttachment	object	No	Parameter untuk membuat desktop cloud tanpa templat. Parameter ini tidak valid ketika parameter BundleId ditentukan.
ImageId	string	No	ID image.	m-39ddhdb0ggzjx*****
SystemDiskCategory	string	No	Tipe Tipe disk sistem. Tipe Tipe disk sistem harus sama dengan tipe Tipe disk data. Nilai valid: cloud_auto: Tipe disk ultra SSD standar cloud_essd: Tipe disk ESSD	cloud_auto
SystemDiskSize	integer	No	Kapasitas disk sistem. Nilai valid: 60 hingga 500 GiB, dalam kelipatan 10 GiB.	40
SystemDiskPerLevel	string	No	Tingkat kinerja (PL) cloud disk ESSD. Parameter ini diperlukan ketika cloud disk ESSD dipilih. Nilai valid: PL0 PL1	PL0
DataDiskSize	integer	No	Kapasitas disk pengguna. Nilai valid: 40 hingga 2040 GiB, dalam kelipatan 10 GiB.	40
DataDiskCategory	string	No	Tipe Tipe disk data. Tipe Tipe disk sistem harus sama dengan tipe Tipe disk data. Nilai valid: cloud_auto: Tipe disk ultra SSD standar cloud_essd: Tipe disk ESSD	cloud_auto
DataDiskPerLevel	string	No	Tingkat kinerja (PL) cloud disk ESSD. Parameter ini diperlukan ketika cloud disk ESSD dipilih. Nilai valid: PL0 PL1	PL0
DefaultLanguage	string	No	Bahasa. Nilai valid: zh-CN zh-HK en-US ja-JP	zh-CN
DesktopType	string	No	Spesifikasi desktop cloud. Anda dapat memanggil DescribeDesktopTypes untuk mengkueri ID spesifikasi yang didukung.	eds.enterprise_office.8c16g
TimerGroupId	string	No	ID kelompok tugas terjadwal.	ccg-0caoeogrk9m5****
SavingPlanId	string	No	Catatan Bidang ini tidak tersedia untuk digunakan.	spn-26c1b7bcrjcI****
ResellerOwnerUid	integer	No	ID pengguna untuk kepemilikan Sumber daya dalam pola reseller. Parameter ini tidak diperlukan dalam pola non-reseller.	1828644634819902
ExtendInfo	string	No	Informasi tambahan dalam format string JSON. Parameter ini hanya tersedia untuk pelanggan internal.	{}
AppRuleId	string	No	ID kebijakan kontrol aplikasi.	bwr-245d4e0e6b7d42f5afa97eb3fbc7e488
QosRuleId	string	No	ID aturan pembatasan laju jaringan publik.	qos-52fqmg6kvyro7zu4l
ChannelCookie	string	No	Catatan Bidang ini tidak tersedia untuk digunakan.	PBKB1QbqEl2tslEuU6gRrLxvCFBU2M%2FVD0Eru6Oo%2FI9LTU3XQhvq3PGMWarE%2BPJdkNvCqT3blqlRSthNy4A%2BJQ%3D%3D
PurchaseOptions	object	No	Parameter tambahan untuk tipe pembelian tertentu.
MonthlyCredits	integer	No	Paket kredit bulanan untuk membeli Sumber daya Agen. Nilai valid: 200, 1600, dan 4000.	200
OuPath	string	No	Jalur OU. Jika ditentukan, desktop cloud ditambahkan ke unit organisasi (OU) yang sesuai di Direktori Aktif (AD).	test.com/wuyingtest/computers
SubPayType	string	No

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
OrderId	string	ID pesanan. Catatan Parameter ini dikembalikan hanya jika parameter permintaan ChargeType diatur ke PrePaid.	123456789
RequestId	string	ID permintaan.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopId	array	Daftar ID desktop cloud. Jika beberapa desktop cloud dibuat dalam satu panggilan, beberapa ID desktop cloud dikembalikan.
	string	ID desktop cloud.	["ecd-gx2x1dhsmucyy****"]

Contoh

Respons sukses

JSONformat

{
  "OrderId": "123456789",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DesktopId": [
    "[\"ecd-gx2x1dhsmucyy****\"]"
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidEncryptionKey.Missing	Parameter VolumeEncryptionKey is missing.
400	InvalidEncryptionKey.NotAuthorized	Eds service cannot access the given VolumeEncryptionKey.
400	InvalidEncryptionKey.NotFound	The specified VolumeEncryptionKey is not found.
400	InvalidImageStatus.NotValid	The specified image status is not valid.
400	InvalidImageVersion.NotSupported	The specified image version is no longer supported.
400	InvalidMemberIp.DesktopAmount	The desktop amount need to be 1.
400	InvalidPolicyGroup.Status	The target policy group is being created. Please try again later.
400	Protocol.NotAllowed	Procotol of the image is not allowed.
400	ExistedHostname	The specified hostname is existed on the domain.
400	HostnameCannotCustomizeForLinux	Customizing hostname is not supported for Linux desktop.
400	IncorrectDirectoryStatus	Only registered directory can create desktop.
400	IncorrectDirectoryType	The protocol type of directory and desktop do not match.
400	InvalidAmount	The specified Amount is not a valid value.
400	InvalidAmount.NotTimesOfUsers	The specified Amount is notmatch EndUserId size.
400	InvalidDesktopBundle.NotFound	The specified param BundleId is not found.
400	InvalidDirectoryId.NotFound	The specified param DirectoryId is not found.
400	InvalidDirectoryType.NotSupported	The specified DirectoryType is not supported.
400	InvalidEncryptionEnabled.Invalid	The parameter VolumeEncryptionEnabled is invalid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.