CreateInstance - ApsaraMQ for RocketMQ

Membuat instance ApsaraMQ for RocketMQ 5.x.

Deskripsi operasi

Penting OpenAPI yang disediakan oleh Alibaba Cloud merupakan API manajemen yang digunakan untuk mengelola dan mengkueri resource Layanan Alibaba Cloud. Integrasi OpenAPI hanya ditujukan untuk keperluan manajemen. Jangan mengandalkan OpenAPI untuk tautan data inti yang mengirim dan menerima pesan, karena hal ini dapat membahayakan tautan Anda.

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

*Instance

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

None

Sintaks permintaan

POST /instances HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
clientToken	string	No	Token yang dihasilkan client untuk memastikan idempotensi permintaan. Token harus unik di antara permintaan berbeda dan panjangnya maksimal 64 karakter ASCII.	c2c5d1274a8d4317a13bc5b0d4******
body	object	No	Badan permintaan.
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	Kode layanan instans. Kode layanan untuk ApsaraMQ for RocketMQ adalah rmq.	rmq
seriesCode	string	Yes	Kode seri utama instans. Untuk informasi selengkapnya tentang perbedaan antar seri utama, lihat Pemilihan Produk. Nilai yang valid: standard: Edisi Standar ultimate: Edisi Platinum professional: Edisi Profesional dedicated: Edisi Eksklusif shared: Edisi Bersama Penting Setelah instans dibuat, Anda hanya dapat melakukan peningkatan seri utamanya. Anda tidak dapat menurunkan spesifikasinya. Jalur peningkatan adalah: Edisi Standar > Edisi Profesional > Edisi Platinum. Misalnya, Anda dapat meningkatkan instans dari Edisi Standar ke Edisi Profesional, tetapi tidak dapat menurunkannya dari Edisi Profesional ke Edisi Standar. Valid values: standard : Edisi Standar ultimate : Edisi Platinum professional : Edisi Profesional	standard
subSeriesCode	string	Yes	Kode sub-seri instans. Untuk informasi selengkapnya tentang perbedaan antar sub-seri, lihat Pemilihan Produk. Nilai yang valid: cluster_ha: Edisi Kluster dengan ketersediaan tinggi single_node: Edisi Pengujian Single-node serverless: Instans arsitektur tanpa server Jika Anda menetapkan seri utama ke ultimate (Edisi Platinum), Anda harus menetapkan sub-seri ke cluster_ha (Edisi Kluster dengan ketersediaan tinggi). Penting Setelah instans dibuat, Anda tidak dapat mengubah sub-serinya. Valid values: serverless : Edisi Serverless cluster_ha : Edisi Kluster dengan ketersediaan tinggi single_node : Edisi Pengujian Single-node	cluster_ha
paymentType	string	Yes	Metode penagihan instans. ApsaraMQ for RocketMQ mendukung langganan dan bayar sesuai penggunaan. Nilai yang valid: PayAsYouGo: pay-as-you-go. Ini adalah mode pascabayar di mana Anda ditagih berdasarkan resource yang digunakan. Subscription: subscription. Ini adalah mode prabayar di mana Anda membayar sebelum menggunakan resource. Untuk informasi selengkapnya, lihat Metode Penagihan. Valid values: PayAsYouGo : pay-as-you-go Subscription : subscription	Subscription
period	integer	No	Durasi langganan. Parameter ini hanya berlaku ketika paymentType diatur ke Subscription. Nilai yang valid: Jika Anda membeli per bulan: 1, 2, 3, 4, 5, dan 6 Jika Anda membeli per tahun: 1, 2, dan 3	3
periodUnit	string	No	Unit durasi langganan. Nilai yang valid: Month: beli per bulan Year: beli per tahun Valid values: Month : beli per bulan Year : beli per tahun	Month
autoRenew	boolean	No	Menentukan apakah akan mengaktifkan perpanjangan otomatis. Parameter ini hanya berlaku ketika paymentType diatur ke Subscription. true: mengaktifkan perpanjangan otomatis false: menonaktifkan perpanjangan otomatis Valid values: true : mengaktifkan perpanjangan otomatis false : menonaktifkan perpanjangan otomatis	true
autoRenewPeriod	integer	No	Siklus perpanjangan otomatis. Parameter ini hanya berlaku jika autoRenew diatur ke true. Satuan: bulan. Nilai yang valid: Jika Anda memperpanjang per bulan: 1, 2, 3, 6, dan 12	3
remark	string	No	Catatan untuk instans.	This is the remark for test.
productInfo	object	No	Spesifikasi instans.
msgProcessSpec	string	No	Spesifikasi komputasi untuk pengiriman dan penerimaan pesan. Untuk informasi selengkapnya tentang batas TPS pengiriman dan penerimaan pesan, lihat Tipe Instans.	rmq.s2.2xlarge
sendReceiveRatio	number	No	Rasio TPS pengiriman pesan terhadap total TPS instans. Misalnya, jika total TPS instans adalah 1.000 dan rasionya 0,8, maka TPS pengiriman adalah 800 dan TPS penerimaan adalah 200. Nilai yang valid: [0,05, 0,95]. Nilai default: 0,5.	0.5
autoScaling	boolean	No	Menentukan apakah akan mengaktifkan burst scaling di luar spesifikasi. Nilai yang valid: true: mengaktifkan burst scaling false: menonaktifkan burst scaling Jika Anda mengaktifkan burst scaling, Anda dapat melebihi TPS dasar instans. Anda akan dikenai biaya untuk TPS tambahan tersebut. Untuk informasi selengkapnya tentang penagihan, lihat Biaya Komputasi. Catatan Hanya beberapa tipe instans yang mendukung burst scaling. Untuk informasi selengkapnya tentang tipe instans yang didukung, lihat Tipe Instans. Valid values: true : mengaktifkan burst scaling false : menonaktifkan burst scaling	true
messageRetentionTime	integer	No	Periode retensi pesan. Satuan: jam. Untuk informasi nilai yang valid, lihat bagian "Periode Retensi Pesan" dalam topik "Kuota Resource" pada Batasan. Penyimpanan pesan ApsaraMQ for RocketMQ bersifat serverless dan elastis. Anda dikenai biaya berdasarkan penyimpanan aktual yang digunakan. Anda dapat mengubah periode retensi pesan untuk mengontrol kapasitas penyimpanan. Untuk informasi selengkapnya, lihat Biaya Penyimpanan.	72
storageEncryption	boolean	No	Menentukan apakah akan mengaktifkan enkripsi penyimpanan.	false
storageSecretKey	string	No	Kunci untuk enkripsi penyimpanan.	xxxxx
capacityType	string	No	Mode kapasitas. `provisioned`: kapasitas terjadwal dan elastis. `onDemand`: bayar sesuai penggunaan.	provisioned
provisionedCapacity	integer	No	Kapasitas yang dialokasikan.	5000
traceOn	boolean	No	Menentukan apakah akan mengaktifkan fitur jejak pesan. true: mengaktifkan fitur jejak pesan. false: menonaktifkan fitur jejak pesan. Parameter ini hanya berlaku untuk instans Serverless. Jika Anda mengaktifkan fitur jejak pesan, Anda akan dikenai biaya untuk jejak pesan tersebut. Untuk informasi selengkapnya tentang penagihan, lihat Penagihan Serverless. Parameter ini tidak berlaku untuk instans pay-as-you-go dan subscription. Fitur jejak pesan diaktifkan secara default untuk instans tersebut.	true
networkInfo	object	Yes	Konfigurasi jaringan.
vpcInfo	object	Yes	Konfigurasi VPC.
vpcId	string	Yes	ID VPC tempat instans terhubung. Catatan Setelah instans ApsaraMQ for RocketMQ dibuat, Anda tidak dapat mengubah VPC-nya. Untuk mengubah VPC, Anda harus merilis instans tersebut dan membeli yang baru.	vpc-wz9qt50xhtj9krb******
vSwitchId `deprecated`	string	No	ID vSwitch tempat instans terhubung. Jika terdapat beberapa vSwitch, pisahkan ID-nya dengan tanda pipa vertikal (\|). Catatan Setelah instans ApsaraMQ for RocketMQ dibuat, Anda tidak dapat mengubah vSwitch-nya. Untuk mengubah vSwitch, Anda harus merilis instans tersebut dan membeli yang baru. Penting Parameter ini sudah usang. Gunakan parameter 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, Anda tidak dapat mengubah vSwitch-nya. Untuk mengubah vSwitch, Anda harus merilis instans tersebut dan membeli yang baru. Penting Ini adalah parameter yang diperlukan. Karena parameter vSwitchId sudah usang, gunakan parameter ini untuk menentukan vSwitch.
	object	No
vSwitchId	string	No	ID vSwitch tempat instans terhubung.	vsw-uf6gwtbn6etadpv*******
internetInfo	object	Yes	Konfigurasi jaringan publik.
internetSpec	string	Yes	Menentukan apakah akan mengaktifkan akses jaringan publik. Nilai yang valid: enable: mengaktifkan akses jaringan publik disable: menonaktifkan akses jaringan publik Secara default, instans diakses melalui VPC. Jika Anda mengaktifkan akses jaringan publik, Anda akan dikenai biaya bandwidth downstream publik. Untuk informasi selengkapnya tentang penagihan, lihat Biaya Akses Jaringan Publik. Valid values: enable : mengaktifkan akses jaringan publik disable : menonaktifkan akses jaringan publik	disable
flowOutType	string	Yes	Metode penagihan untuk akses jaringan publik. Nilai yang valid: payByBandwidth: pay-by-bandwidth. Atur parameter ini ke nilai ini saat Anda mengaktifkan akses jaringan publik. payByTraffic: pay-by-data-transfer. Atur parameter ini ke nilai ini saat Anda mengaktifkan akses jaringan publik. uninvolved: not involved. Atur parameter ini ke nilai ini saat Anda menonaktifkan akses jaringan publik. Valid values: payByBandwidth : pay-by-bandwidth payByTraffic : pay-by-data-transfer uninvolved : not involved	uninvolved
flowOutBandwidth	integer	No	Bandwidth publik. Satuan: Mbit/s. Parameter ini wajib hanya jika Anda mengatur flowOutType ke payByBandwidth. Nilai yang valid: 1 hingga 1000.	100
ipWhitelist `deprecated`	array	No	Daftar putih alamat IP akses publik. Anda hanya dapat mengonfigurasi daftar putih alamat IP untuk titik akhir publik. Titik akhir VPC tidak didukung. Jika Anda tidak mengonfigurasi daftar putih alamat IP, semua alamat IP dapat mengakses server ApsaraMQ for RocketMQ melalui jaringan publik. Jika Anda mengonfigurasi daftar putih alamat IP, hanya alamat IP dalam daftar putih yang dapat mengakses server ApsaraMQ for RocketMQ melalui jaringan publik.
	string	No	Rentang alamat IP dalam daftar putih akses publik.	192.168.x.x/24
commodityCode	string	No	Kode komoditas. ons_rmqpost_public_intl: pay-as-you-go ons_rmqsub_public_intl: subscription ons_rmqsrvlesspost_public_intl: instans Serverless Parameter ini wajib untuk instans Serverless.	ons_ rmqpost_public_cn
resourceGroupId	string	No	ID kelompok sumber daya.	rg-aekzy6pist7uuna
tags	array<object>	No	Daftar tag resource.
	object	No	Tag yang dapat Anda tetapkan ke resource.
key	string	No	Kunci tag resource.	xxxKey
value	string	No	Nilai tag resource.	xxxValue
aclInfo	object	No	Informasi kontrol akses.
defaultVpcAuthFree	boolean	No	Menentukan apakah akan mengaktifkan akses tanpa kata sandi melalui VPC untuk pengenalan identitas cerdas. true: mengaktifkan akses tanpa kata sandi false: menonaktifkan akses tanpa kata sandi	false

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik yang dapat Anda gunakan untuk pemecahan masalah.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Menunjukkan apakah panggilan berhasil.	true
data	string	ID instans yang dibuat.	rmq-cn-7e22ody****
code	string	Kode kesalahan.	200
message	string	Pesan kesalahan.	Success
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	instanceId

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": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.