Gunakan API CreateInstance untuk membuat instans-ApsaraMQ for RocketMQ-Alibaba Cloud - ApsaraMQ for RocketMQ

Membuat instans seri ApsaraMQ for RocketMQ 5.x.

Deskripsi operasi

Penting OpenAPI yang disediakan oleh Alibaba Cloud adalah API manajemen dan kontrol yang digunakan untuk mengelola dan mengkueri Sumber daya layanan Alibaba Cloud. Integrasikan hanya ke dalam alur manajemen dan kontrol. Jangan mengandalkan OpenAPI di alur data inti untuk pengiriman dan penerimaan Paket. Jika tidak, risiko dapat terjadi pada alur tersebut.

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

rocketmq:CreateInstance

create

*Instans.

acs:rocketmq:{#regionId}:{#accountId}:Instance/*

rocketmq:InternetSpec

None

Sintaks permintaan

POST /instances HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
clientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Klien menghasilkan nilai parameter ini, yang harus unik di antara permintaan yang berbeda. Token dapat memiliki panjang hingga 64 karakter ASCII.	c2c5d1274a8d4317a13bc5b0d4******
body	object	No	Isi parameter.
instanceName	string	No	Nama instans yang akan dibuat. Jika Anda tidak menentukan parameter ini, ID instans akan digunakan sebagai nama instans.	rmq-cn-72u3048uxxx
serviceCode	string	Yes	Enkoding layanan instans. Enkoding layanan untuk MSMQ for RocketMQ adalah rmq.	rmq
seriesCode	string	Yes	Enkoding seri utama instans. Untuk informasi lebih lanjut mengenai perbedaan antar seri utama, lihat Pemilihan produk. Valid values: standard : Edisi Standar. dedicated : Edisi Dedicated. shared : Edisi Shared. ultimate : Edisi Platinum. professional : Edisi Profesional.	standard
subSeriesCode	string	Yes	Enkoding sub-seri instans. Untuk informasi lebih lanjut mengenai perbedaan antar sub-seri, lihat Pemilihan produk. Jika seri utama diatur ke ultimate (Edisi Platinum), sub-seri hanya dapat diatur ke cluster_ha (Edisi Ketersediaan Tinggi Kluster). Penting Setelah instans dibuat, sub-seri tidak dapat diubah. Valid values: serverless : Edisi Serverless. cluster_ha : Edisi Ketersediaan Tinggi Kluster. single_node : Edisi Pengujian Node Tunggal.	cluster_ha
paymentType	string	Yes	Metode penagihan instans. ApsaraMQ for RocketMQ mendukung metode penagihan langganan dan pay-as-you-go. Untuk informasi lebih lanjut, lihat Metode penagihan. Valid values: PayAsYouGo : Pay-as-you-go. Pola pembayaran pasca-pemakaian di mana Anda menggunakan sumber daya terlebih dahulu dan membayar kemudian. Subscription : Subscription. Pola pembayaran di muka di mana Anda membayar terlebih dahulu dan menggunakan sumber daya kemudian.	Subscription
period	integer	No	Durasi langganan. Parameter ini hanya berlaku ketika metode penagihan instans diatur ke Subscription. Nilai valid: Langganan bulanan: 1, 2, 3, 4, 5, 6 Langganan tahunan: 1, 2, 3	3
periodUnit	string	No	Unit epoch minimum durasi langganan. Valid values: Month : Langganan bulanan. Year : Langganan tahunan.	Month
autoRenew	boolean	No	Apakah akan mengaktifkan perpanjangan otomatis. Parameter ini hanya berlaku ketika metode penagihan instans diatur ke Subscription. Valid values: true : Perpanjangan otomatis diaktifkan. false : Perpanjangan otomatis dinonaktifkan.	true
autoRenewPeriod	integer	No	Siklus Perpanjangan Otomatis Terpadu. Parameter ini hanya berlaku ketika perpanjangan otomatis diaktifkan. Unit: months. Nilai valid: Perpanjangan bulanan: 1, 2, 3, 6, 12	3
remark	string	No	Keterangan instans.	Ini adalah keterangan untuk pengujian
productInfo	object	No	Informasi spesifikasi instans.
msgProcessSpec	string	No	Spesifikasi komputasi pengiriman dan penerimaan Paket. Untuk informasi lebih lanjut mengenai batas atas TPS untuk pengiriman dan penerimaan Paket, lihat Spesifikasi instans.	rmq.s2.2xlarge
sendReceiveRatio	number	No	Rasio TPS pengiriman Paket terhadap total TPS pengiriman dan penerimaan Paket instans. Sebagai contoh, jika batas atas TPS untuk pengiriman dan penerimaan Paket instans adalah 1000 per detik dan rasio pengiriman Paket adalah 0,8, batas atas TPS untuk pengiriman Paket adalah 800 per detik dan batas atas TPS untuk penerimaan Paket adalah 200 per detik. Nilai valid: [0.05, 0.95]. Nilai default: 0.5.	0.5
autoScaling	boolean	No	Apakah akan mengaktifkan kapasitas elastis burstable di luar spesifikasi. Setelah kapasitas elastis burstable diaktifkan, MSMQ for RocketMQ mengizinkan instans melampaui batas TPS spesifikasi dasar dalam rentang tertentu. Bagian yang melampaui spesifikasi dasar akan dikenakan biaya spesifikasi elastis tambahan. Untuk informasi lebih lanjut mengenai penagihan, lihat Biaya komputasi. Catatan Hanya instans dengan spesifikasi tertentu yang mendukung kapasitas elastis burstable. Untuk informasi lebih lanjut mengenai instans yang didukung, lihat Spesifikasi instans. Valid values: true : Kapasitas elastis diaktifkan. false : Kapasitas elastis dinonaktifkan.	true
messageRetentionTime	integer	No	Periode retensi Paket. Unit: hours. Untuk rentang nilai valid, lihat Batasan > Kuota Sumber daya > Periode Retensi Paket. Log broker di MSMQ for RocketMQ sepenuhnya arsitektur tanpa server dan elastis. Biaya dikenakan berdasarkan ruang penyimpanan yang sebenarnya digunakan. Anda dapat mengontrol kapasitas penyimpanan dengan menyesuaikan periode retensi Paket. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.	72
storageEncryption	boolean	No	Apakah enkripsi penyimpanan diaktifkan.	false
storageSecretKey	string	No	Kunci untuk enkripsi penyimpanan.	xxxxx
capacityType	string	No	Pola kapasitas. Valid values: provisioned : Provisioned + elastic. ondemand : Pay-as-you-go.	provisioned
provisionedCapacity	integer	No	Kapasitas provisioned.	5000
traceOn	boolean	No	Apakah akan mengaktifkan fitur jejak Paket. true: Mengaktifkan fitur jejak Paket. false: Menonaktifkan fitur jejak Paket. Parameter ini hanya berlaku untuk instans arsitektur tanpa server. Jika fitur jejak Paket diaktifkan, biaya jejak Paket akan dikenakan. Untuk informasi lebih lanjut mengenai penagihan, lihat deskripsi penagihan arsitektur tanpa server. Untuk instans pay-as-you-go dan instans langganan, parameter ini tidak berlaku. Fitur jejak Paket didukung secara default terlepas dari apakah parameter ini diaktifkan.	true
drReplicationMode	string	No	Pola replikasi lintas wilayah. Valid values: async_cross_az : Replikasi Asinkron. sync_cross_az : Replikasi Sinkron.	async_cross_az
adaptiveElasticity	boolean	No	Apakah akan mengaktifkan elastisitas adaptif. Nilai true menunjukkan bahwa elastisitas adaptif diaktifkan. Nilai false menunjukkan bahwa elastisitas adaptif dinonaktifkan.
networkInfo	object	Yes	Informasi konfigurasi jaringan.
vpcInfo	object	Yes	Informasi konfigurasi VPC.
vpcId	string	Yes	ID VPC yang akan diasosiasikan dengan instans. Catatan Setelah instans ApsaraMQ for RocketMQ dibuat, VPC yang dipilih tidak dapat diubah. Untuk memodifikasi VPC yang diasosiasikan, rilis instans ApsaraMQ for RocketMQ yang ada dan beli yang baru.	vpc-wz9qt50xhtj9krb******
vSwitchId `deprecated`	string	No	ID vSwitch yang diasosiasikan dengan instans. Jika terdapat beberapa vSwitch, pisahkan dengan garis vertikal (\|). Catatan Setelah instans ApsaraMQ for RocketMQ dibuat, vSwitch yang dipilih tidak dapat diubah. Untuk memodifikasi vSwitch yang diasosiasikan, rilis instans ApsaraMQ for RocketMQ yang ada dan beli yang baru. Penting Bidang ini tidak direkomendasikan. Gunakan bidang vSwitches sebagai gantinya.	vsw-uf6gwtbn6etadpv*******
securityGroupIds	string	No	ID grup keamanan.	sg-bp17hpmgz96tvnsdy6so
vSwitches	array<object>	No	Daftar vSwitch. Catatan Setelah instans ApsaraMQ for RocketMQ dibuat, vSwitch yang dipilih tidak dapat diubah. Untuk memodifikasi vSwitch yang diasosiasikan, rilis instans ApsaraMQ for RocketMQ yang ada dan beli yang baru. Penting Bidang ini wajib diisi. Karena bidang vSwitchId tidak lagi direkomendasikan, gunakan bidang ini untuk mengonfigurasi vSwitch.
	object	No
vSwitchId	string	No	ID vSwitch yang diasosiasikan dengan instans.	vsw-uf6gwtbn6etadpv*******
internetInfo	object	Yes	Informasi konfigurasi Internet.
internetSpec	string	Yes	Apakah akan mengaktifkan akses jaringan publik. Secara default, instans mendukung akses VPC. Jika Anda mengaktifkan akses jaringan publik, ApsaraMQ for RocketMQ akan mengenakan biaya untuk bandwidth downstream jaringan publik. Untuk informasi lebih lanjut mengenai penagihan, lihat Biaya akses jaringan publik. Valid values: enable : Mengaktifkan akses jaringan publik. disable : Menonaktifkan akses jaringan publik.	disable
flowOutType	string	Yes	Tipe penagihan Internet. Valid values: payByBandwidth : Penagihan bandwidth tetap. Atur parameter ini ke nilai ini saat akses jaringan publik diaktifkan. payByTraffic : Penagihan berdasarkan lalu lintas. Atur parameter ini ke nilai ini saat akses jaringan publik diaktifkan. uninvolved : Tidak berlaku. Atur parameter ini ke nilai ini saat akses jaringan publik dinonaktifkan.	uninvolved
flowOutBandwidth	integer	No	Spesifikasi bandwidth Internet. Unit: Mb/s. Parameter ini hanya wajib diisi saat tipe penagihan Internet diatur ke penagihan bandwidth tetap. Nilai valid: 1 hingga 1000.	100
ipWhitelist `deprecated`	array	No	Daftar putih IP akses jaringan publik. Hanya endpoint publik yang mendukung konfigurasi daftar putih IP. Endpoint VPC tidak mendukung fitur ini. Jika tidak ada daftar putih IP yang dikonfigurasi, semua rentang alamat IP diizinkan untuk mengakses server ApsaraMQ for RocketMQ melalui Internet secara default. Jika daftar putih IP dikonfigurasi, hanya alamat IP dalam daftar putih yang diizinkan untuk mengakses server ApsaraMQ for RocketMQ melalui Internet.
	string	No	Blok CIDR dalam daftar putih akses jaringan publik.	192.168.x.x/24
commodityCode `deprecated`	string	No	Kode komoditas. ons_rmqpost_public_intl: pay-as-you-go. ons_rmqsub_public_intl: langganan. ons_rmqsrvlesspost_public_intl: instans arsitektur tanpa server. Parameter ini wajib diisi untuk instans arsitektur tanpa server.	ons_ rmqpost_public_cn
resourceGroupId	string	No	ID kelompok sumber daya.	rg-aekzy6pist7uuna
tags	array<object>	No	Daftar tag sumber daya.
	object	No	Tag sumber daya.
key	string	No	Kunci tag sumber daya.	xxxKey
value	string	No	Nilai tag sumber daya.	xxxValue
aclInfo	object	No	Informasi kontrol akses.
defaultVpcAuthFree	boolean	No	Apakah akan mengaktifkan akses tanpa otentikasi untuk endpoint VPC saat tipe pengenalan identitas cerdas digunakan. Nilai valid: true: Mengaktifkan akses tanpa otentikasi. false: Menonaktifkan akses tanpa otentikasi.	false

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
requestId	string	ID permintaan. Setiap ID permintaan bersifat unik dan dapat digunakan untuk memecahkan masalah.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Menunjukkan apakah operasi berhasil.	true
data	string	ID instans yang dibuat.	rmq-cn-7e22ody****
code	string	Kode kesalahan.	200
message	string	Paket kesalahan.	Success
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Paket kesalahan dinamis.	InstansId

Contoh

Respons sukses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": "rmq-cn-7e22ody****",
  "code": "200",
  "message": "Success.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId.",
  "dynamicMessage": "InstansId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.