All Products
Search

This Product

    ApsaraMQ for RocketMQ:CreateInstance

    Document Center

    ApsaraMQ for RocketMQ:CreateInstance

    Last Updated:Jul 23, 2026

    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 dalam sistem manajemen dan kontrol. Jangan mengandalkan OpenAPI dalam tautan data inti untuk pengiriman dan penerimaan Paket. Jika tidak, risiko dapat terjadi.

    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/*
    • 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. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara berbagai permintaan. Token hanya dapat berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter.

    c2c5d1274a8d4317a13bc5b0d4******
    body

    object

    No

    Body parameter.

    instanceName

    string

    No

    Nama instans yang akan dibuat.

    rmq-cn-72u3048uxxx.
    serviceCode

    string

    Yes

    Kode layanan instans. Kode layanan untuk MSMQ RocketMQ adalah rmq.

    rmq.
    seriesCode

    string

    Yes

    Kode seri utama instans. Untuk informasi lebih lanjut tentang perbedaan antar seri utama, lihat Pemilihan produk.

    Valid values:

    • standard :

      Edisi Standar.

    • ultimate :

      Edisi Platinum.

    • professional :

      Edisi Profesional.

    • dedicated :

      Edisi Khusus.

    • shared :

      Edisi Bersama.

    standard.
    subSeriesCode

    string

    Yes

    Kode sub-seri instans. Untuk informasi lebih lanjut tentang perbedaan antar sub-seri, lihat Pemilihan produk.

    Valid values:

    • serverless :

      Edisi Serverless.

    • cluster_ha :

      Edisi ketersediaan tinggi kluster.

    • single_node :

      Edisi pengujian node tunggal.

    cluster_ha.
    paymentType

    string

    Yes

    Tipe pembayaran instans. MSMQ RocketMQ mendukung langganan dan bayar sesuai pemakaian.

    Valid values:

    • PayAsYouGo :

      Bayar sesuai pemakaian. Pola pascapembayaran di mana Anda menggunakan Sumber daya terlebih dahulu dan membayar nanti.

    • Subscription :

      Langganan. Pola prabayar di mana Anda membayar terlebih dahulu dan menggunakan Sumber daya nanti.

    Subscription.
    period

    integer

    No

    Durasi langganan. Parameter ini hanya berlaku jika tipe pembayaran instans adalah Langganan.

    3
    periodUnit

    string

    No

    Unit epoch minimum dari durasi langganan.

    Valid values:

    • Month :

      Langganan bulanan.

    • Year :

      Langganan tahunan.

    Month.
    autoRenew

    boolean

    No

    Apakah akan mengaktifkan perpanjangan otomatis. Parameter ini hanya berlaku jika tipe pembayaran instans adalah Langganan.

    Valid values:

    • true :

      Aktifkan perpanjangan otomatis.

    • false :

      Nonaktifkan perpanjangan otomatis.

    true.
    autoRenewPeriod

    integer

    No

    Siklus Perpanjangan Otomatis Terpadu. Parameter ini hanya berlaku jika perpanjangan otomatis diaktifkan. Unit: bulan.

    3
    remark

    string

    No

    Catatan instans.

    This is the remark for test.
    productInfo

    object

    No

    Informasi spesifikasi instans.

    msgProcessSpec

    string

    No

    Spesifikasi komputasi untuk pengiriman dan penerimaan Paket. Untuk informasi lebih lanjut tentang 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.

    0.5
    autoScaling

    boolean

    No

    Apakah akan mengaktifkan skalabilitas elastis burstable di luar spesifikasi.

    Valid values:

    • true :

      Aktifkan skalabilitas elastis.

    • false :

      Nonaktifkan skalabilitas elastis.

    true.
    messageRetentionTime

    integer

    No

    Periode retensi pesan. Unit: jam.

    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 :

      Tersedia + elastis.

    • ondemand :

      Bayar sesuai pemakaian.

    provisioned.
    provisionedCapacity

    integer

    No

    Kapasitas tersedia.

    5000
    traceOn

    boolean

    No

    Apakah fitur jejak Paket 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

    networkInfo

    object

    Yes

    Informasi konfigurasi jaringan.

    vpcInfo

    object

    Yes

    Informasi konfigurasi VPC.

    vpcId

    string

    Yes

    The ID of the VPC to which the instance is connected.

    Catatan

    After a Message Queue for Apache RocketMQ instance is created, you cannot change the VPC to which the instance is connected. If you want to change the VPC, you must release the instance and purchase a new one.

    vpc-wz9qt50xhtj9krb******
    vSwitchId deprecated

    string

    No

    The ID of the vSwitch to which the instance is connected. If you want to connect the instance to multiple vSwitches, separate the vSwitch IDs with vertical bars (|).

    Catatan

    After a Message Queue for Apache RocketMQ instance is created, you cannot change the vSwitch to which the instance is connected. If you want to change the vSwitch, you must release the instance and purchase a new one.

    Penting

    This parameter is deprecated. We recommend that you use the vSwitches parameter.

    vsw-uf6gwtbn6etadpv*******
    securityGroupIds

    string

    No

    The ID of the security group.

    sg-bp17hpmgz96tvnsdy6so
    vSwitches

    array<object>

    No

    The list of vSwitches.

    Catatan

    After a Message Queue for Apache RocketMQ instance is created, you cannot change the vSwitches for the instance. If you want to change the vSwitches, you must release the instance and purchase a new one.

    Penting

    This parameter is required. We recommend that you use this parameter to specify a vSwitch instead of the deprecated vSwitchId parameter.

    object

    No

    The vSwitches.

    vSwitchId

    string

    No

    The ID of the vSwitch to which the instance is connected.

    vsw-uf6gwtbn6etadpv*******
    internetInfo

    object

    Yes

    Informasi konfigurasi jaringan publik.

    internetSpec

    string

    Yes

    Specifies whether to enable Internet access.

    By default, instances can be accessed only within a VPC. If you enable Internet access for an instance, you are charged for Internet traffic that is generated by the instance. For more information, see Internet access fees.

    Valid values:

    • enable :

      Enables Internet access.

    • disable :

      Disables Internet access.

    disable
    flowOutType

    string

    Yes

    The billing method for Internet access.

    Valid values:

    • payByBandwidth :

      pay-by-bandwidth. This billing method is available only when you enable Internet access.

    • payByTraffic :

      pay-by-traffic. This billing method is available only when you enable Internet access.

    • uninvolved :

      not involved. This value is used when you disable Internet access.

    uninvolved
    flowOutBandwidth

    integer

    No

    The Internet bandwidth. Unit: Mbit/s.

    This parameter is required only when the billing method for Internet access is pay-by-bandwidth.

    Value range: 1 to 1000.

    100
    ipWhitelist deprecated

    array

    No

    The IP address whitelist for Internet access. You can configure an IP address whitelist only for public endpoints. VPC endpoints do not support this feature.

    • If you do not configure an IP address whitelist, all IP addresses are allowed to access the Message Queue for Apache RocketMQ instance over the Internet.

    • If you configure an IP address whitelist, only the IP addresses in the whitelist can access the Message Queue for Apache RocketMQ instance over the Internet.

    string

    No

    An IP address or CIDR block in the whitelist.

    192.168.x.x/24
    commodityCode deprecated

    string

    No

    Kode komoditas.

    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 mengizinkan akses bebas otentikasi dari endpoint VPC saat tipe pengenalan identitas cerdas digunakan.

    false.

    Elemen respons

    Element

    Type

    Description

    Example

    object

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

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.