All Products
Search

This Product

    ApsaraMQ for RocketMQ:CreateInstance

    Document Center

    ApsaraMQ for RocketMQ:CreateInstance

    Last Updated:Apr 01, 2026

    Membuat instance ApsaraMQ for RocketMQ 5.x.

    Deskripsi operasi

    Penting Alibaba Cloud OpenAPI adalah API management. Anda dapat menggunakannya untuk mengelola dan mengkueri resource layanan Alibaba Cloud. Integrasikan API ini hanya ke dalam sistem manajemen Anda. Jangan menggunakannya untuk tautan data inti yang mengirim dan menerima pesan, karena praktik tersebut menimbulkan risiko keamanan pada tautan data 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 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 seluruh permintaan. 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. Untuk ApsaraMQ for RocketMQ, kode layanannya adalah rmq.

    rmq
    seriesCode

    string

    Yes

    Kode seri utama instans. Untuk perbedaan antar seri utama, lihat Pemilihan produk.

    Nilai yang valid:

    • standard: Standard Edition

    • ultimate: Platinum Edition

    • professional: Professional Edition

    • dedicated: Exclusive Edition

    • shared: Shared Edition

    Penting Setelah membuat instans, Anda hanya dapat melakukan upgrade seri utamanya. Anda tidak dapat menurunkan spesifikasinya. Jalur upgrade-nya adalah: Standard Edition → Professional Edition → Platinum Edition. Misalnya, Anda dapat meng-upgrade dari Standard Edition ke Professional Edition, tetapi tidak sebaliknya.

    Valid values:

    • standard :

      Standard Edition

    • ultimate :

      Platinum Edition

    • professional :

      Professional Edition

    standard
    subSeriesCode

    string

    Yes

    Kode sub-seri instans. Untuk perbedaan antar sub-seri, lihat Pemilihan produk.

    Nilai yang valid:

    • cluster_ha: High-availability Cluster Edition

    • single_node: Single-node Testing Edition

    • serverless: Serverless instance

    Jika Anda mengatur seri utama ke ultimate (Platinum Edition), Anda hanya dapat mengatur sub-seri ke cluster_ha (High-availability Cluster Edition).

    Penting Setelah membuat instans, Anda tidak dapat mengubah sub-serinya.

    Valid values:

    • serverless :

      Serverless Edition

    • cluster_ha :

      High-availability Cluster Edition

    • single_node :

      Single-node Testing Edition

    cluster_ha
    paymentType

    string

    Yes

    Metode penagihan untuk instans. ApsaraMQ for RocketMQ mendukung subscription dan pay-as-you-go.

    Nilai yang valid:

    • PayAsYouGo: Pay-as-you-go. Ini adalah model pascabayar di mana Anda membayar setelah penggunaan.

    • Subscription: Subscription. Ini adalah model prabayar di mana Anda membayar sebelum penggunaan.

    Untuk informasi lebih lanjut, 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:

    • Pembelian bulanan: 1, 2, 3, 4, 5, atau 6

    • Pembelian tahunan: 1, 2, atau 3

    3
    periodUnit

    string

    No

    Unit durasi langganan.

    Nilai yang valid:

    • Month: Pembelian per bulan.

    • Year: Pembelian per tahun.

    Valid values:

    • Month :

      Pembelian per bulan.

    • Year :

      Pembelian per tahun.

    Month
    autoRenew

    boolean

    No

    Menentukan apakah akan mengaktifkan perpanjangan otomatis. Parameter ini hanya berlaku ketika paymentType diatur ke Subscription.

    • true: Aktifkan perpanjangan otomatis.

    • false: Nonaktifkan perpanjangan otomatis.

    Valid values:

    • true :

      Aktifkan perpanjangan otomatis.

    • false :

      Nonaktifkan perpanjangan otomatis.

    true
    autoRenewPeriod

    integer

    No

    Periode perpanjangan otomatis. Parameter ini hanya berlaku ketika perpanjangan otomatis diaktifkan. Satuan: bulan.

    Nilai yang valid:

    • Perpanjangan bulanan: 1, 2, 3, 6, atau 12

    3
    remark

    string

    No

    Keterangan tentang instans.

    This is the remark for test.
    productInfo

    object

    No

    Spesifikasi instans.

    msgProcessSpec

    string

    No

    Spesifikasi komputasi untuk pengiriman dan penerimaan pesan. Untuk batas TPS maksimum, lihat Tipe instans.

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    No

    Rasio TPS pengiriman pesan terhadap TPS total instans.

    Contohnya, jika TPS maksimum suatu instans adalah 1.000 dan rasionya 0,8, maka TPS maksimum untuk pengiriman pesan adalah 800 dan TPS maksimum untuk penerimaan pesan adalah 200.

    Nilainya harus berada dalam rentang [0,05, 0,95]. Nilai default: 0,5.

    0.5
    autoScaling

    boolean

    No

    Menentukan apakah akan mengaktifkan TPS elastis.

    Nilai yang valid:

    • true: Aktifkan TPS elastis.

    • false: Nonaktifkan TPS elastis.

    Jika Anda mengaktifkan TPS elastis, ApsaraMQ for RocketMQ memungkinkan instans melebihi batas TPS dari spesifikasi dasarnya dalam rentang tertentu. Anda akan dikenai biaya untuk TPS tambahan tersebut. Untuk detail penagihan, lihat Biaya komputasi.

    Catatan

    TPS elastis hanya didukung untuk tipe instans tertentu. Untuk informasi lebih lanjut, lihat Tipe instans.

    Valid values:

    • true :

      Aktifkan TPS elastis.

    • false :

      Nonaktifkan TPS elastis.

    true
    messageRetentionTime

    integer

    No

    Periode retensi pesan. Satuan: jam.

    Untuk nilai yang valid, lihat batasan periode retensi pesan pada bagian "Kuota resource" di Batasan.

    ApsaraMQ for RocketMQ menyediakan penyimpanan pesan tanpa server dan elastis. Anda dikenai biaya berdasarkan penyimpanan aktual yang digunakan. Ubah periode retensi pesan untuk mengontrol kapasitas penyimpanan. Untuk informasi lebih lanjut, 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. Nilai yang valid: provisioned (reserved and elastic) dan ondemand (pay-as-you-go).

    provisioned
    provisionedCapacity

    integer

    No

    Kapasitas yang dialokasikan.

    5000
    traceOn

    boolean

    No

    Menentukan apakah akan mengaktifkan fitur jejak pesan.

    Nilai yang valid: true dan false. Parameter ini hanya berlaku untuk instans Serverless. Jika Anda mengaktifkan pelacakan pesan, Anda akan dikenai biaya untuk jejak tersebut. Untuk detail penagihan, lihat penagihan Serverless. Parameter ini tidak berlaku untuk instans pay-as-you-go atau subscription. Pelacakan pesan diaktifkan secara default untuk instans tersebut.

    true
    drReplicationMode

    string

    No

    async_cross_az
    networkInfo

    object

    Yes

    Konfigurasi jaringan.

    vpcInfo

    object

    Yes

    Konfigurasi VPC.

    vpcId

    string

    Yes

    ID VPC tempat instans terhubung.

    Catatan

    Setelah membuat instans ApsaraMQ for RocketMQ, Anda tidak dapat mengubah VPC-nya. Untuk mengubah VPC, rilis instans tersebut dan beli 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 membuat instans ApsaraMQ for RocketMQ, Anda tidak dapat mengubah vSwitch-nya. Untuk mengubah vSwitch, rilis instans tersebut dan beli yang baru.

    Penting Parameter ini sudah tidak digunakan lagi. Gunakan parameter vSwitches sebagai gantinya.

    vsw-uf6gwtbn6etadpv*******
    securityGroupIds

    string

    No

    ID security group.

    sg-bp17hpmgz96tvnsdy6so
    vSwitches

    array<object>

    No

    Daftar vSwitch.

    Catatan

    Setelah membuat instans ApsaraMQ for RocketMQ, Anda tidak dapat mengubah vSwitch-nya. Untuk mengubah vSwitch, rilis instans tersebut dan beli yang baru.

    Penting Ini adalah parameter yang diperlukan. Karena vSwitchId sudah tidak digunakan lagi, gunakan parameter ini untuk mengonfigurasi vSwitch.

    object

    No

    vSwitchId

    string

    No

    ID vSwitch tempat instans terhubung.

    vsw-uf6gwtbn6etadpv*******
    internetInfo

    object

    Yes

    Konfigurasi Internet.

    internetSpec

    string

    Yes

    Menentukan apakah akan mengaktifkan akses Internet.

    Nilai yang valid:

    • enable: Aktifkan akses Internet.

    • disable: Nonaktifkan akses Internet.

    Secara default, instans terhubung melalui VPC. Jika Anda mengaktifkan akses Internet, Anda akan dikenai biaya untuk bandwidth downstream Internet. Untuk detail penagihan, lihat Biaya akses Internet.

    Valid values:

    • enable :

      Aktifkan akses Internet.

    • disable :

      Nonaktifkan akses Internet.

    disable
    flowOutType

    string

    Yes

    Metode penagihan untuk akses Internet.

    Nilai yang valid:

    • payByBandwidth: pay-by-bandwidth. Atur nilai ini untuk mengaktifkan akses Internet.

    • payByTraffic: pay-by-data-transfer. Atur nilai ini untuk mengaktifkan akses Internet.

    • uninvolved: not applicable. Atur nilai ini untuk menonaktifkan akses Internet.

    Valid values:

    • payByBandwidth :

      pay-by-bandwidth

    • payByTraffic :

      pay-by-data-transfer

    • uninvolved :

      not applicable

    uninvolved
    flowOutBandwidth

    integer

    No

    Spesifikasi bandwidth Internet. Satuan: Mbit/s.

    Parameter ini hanya diperlukan ketika metode penagihan akses Internet adalah pay-by-bandwidth.

    Rentang nilai: 1 hingga 1000.

    100
    ipWhitelist deprecated

    array

    No

    Daftar putih akses publik. Anda hanya dapat mengonfigurasi daftar putih alamat IP untuk endpoint Internet. Endpoint VPC tidak didukung.

    • Jika Anda tidak mengonfigurasi daftar putih alamat IP, semua alamat IP dapat mengakses layanan ApsaraMQ for RocketMQ melalui Internet.

    • Jika Anda mengonfigurasi daftar putih alamat IP, hanya alamat IP dalam daftar putih yang dapat mengakses layanan ApsaraMQ for RocketMQ melalui Internet.

    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: Serverless instance Parameter ini diperlukan 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 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: Aktifkan akses tanpa kata sandi.

    • false: Nonaktifkan akses tanpa kata sandi.

    false

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data yang dikembalikan.

    requestId

    string

    ID permintaan. Setiap ID permintaan bersifat unik. Gunakan ID ini untuk pemecahan masalah.

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

    Menunjukkan apakah permintaan 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.