All Products
Search

This Product

    ApsaraMQ for RocketMQ:GetInstance

    Document Center

    ApsaraMQ for RocketMQ:GetInstance

    Last Updated:Jul 06, 2026

    Mengambil informasi detail dari instans tertentu.

    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. API ini hanya direkomendasikan untuk integrasi dalam jalur manajemen dan kontrol. Penggunaan OpenAPI di jalur data inti untuk pengiriman dan penerimaan Paket sangat dilarang, karena dapat menimbulkan risiko pada tautan data.

    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:GetInstance

    get

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 None None

    Sintaks permintaan

    GET /instances/{instanceId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    Yes

    ID instans yang akan dikueri.

    rmq-cn-7e22ody****

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example

    Tidak ada parameter yang diperlukan.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data tanggapan.

    requestId

    string

    ID permintaan. Setiap permintaan memiliki ID unik yang dapat digunakan untuk memecahkan masalah.

    05AB7FBD-F1D3-5D87-BF78-BD782249****
    success

    boolean

    Apakah operasi berhasil.

    true
    data

    object

    Data tanggapan.

    regionId

    string

    ID wilayah instans.

    cn-hangzhou
    instanceId

    string

    ID instans.

    rmq-cn-7e22ody****
    instanceName

    string

    Nama instans.

    test instance
    status

    string

    Status instans.

    Valid values:

    • RELEASED :

      Released.

    • RUNNING :

      Running.

    • STOPPED :

      Stopped.

    • CHANGING :

      Changing.

    • CREATING :

      Creating.

    RUNNING
    startTime

    string

    Pengatur waktu mulai instans.

    2022-08-01 00:00:00
    expireTime

    string

    Pengatur waktu kedaluwarsa instans.

    2022-09-01 00:00:00
    releaseTime

    string

    Pengatur waktu rilis instans.

    2022-09-07 00:00:00
    userId

    string

    ID pengguna yang memiliki instans.

    111111111111111
    bid

    string

    BID saluran penjualan komoditas.

    26842
    commodityCode

    string

    Kode komoditas instans ApsaraMQ for RocketMQ 5.x, misalnya ons_rmqsub_public_cn.

    ons_rmqsub_public_cn
    serviceCode

    string

    Kode layanan instans. Kode layanan untuk ApsaraMQ for RocketMQ adalah rmq.

    rmq
    seriesCode

    string

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

    Valid values:

    • standard :

      Edisi Standard.

    • shared :

      Edisi Shared.

    • dedicated :

      Edisi Dedicated.

    • ultimate :

      Edisi Platinum.

    • professional :

      Edisi Professional.

    standard
    subSeriesCode

    string

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

    Valid values:

    • serverless :

      Edisi Serverless.

    • cluster_ha :

      Edisi Cluster high-availability.

    • single_node :

      Edisi Single-node.

    cluster_ha
    paymentType

    string

    Tipe pembayaran instans.

    Valid values:

    • PayAsYouGo :

      Pay-as-you-go (pascabayar).

    • Subscription :

      Subscription (prabayar).

    Subscription
    remark

    string

    Catatan instans.

    This is remark for instance.
    networkInfo

    object

    Informasi jaringan.

    vpcInfo

    object

    Informasi VPC.

    vpcId

    string

    ID VPC yang terkait dengan instans.

    vpc-uf6of9452b2pba82c****
    vSwitchId deprecated

    string

    ID vSwitch yang terkait dengan instans.

    Penting Bidang ini tidak digunakan lagi. Gunakan bidang vSwitches sebagai gantinya. Untuk kompatibilitas mundur, bidang ini hanya mengembalikan satu vSwitch.

    vsw-uf6gwtbn6etadpvz7****
    vSwitches

    array<object>

    Daftar vSwitch.

    object

    vSwitchId

    string

    ID vSwitch.

    vsw-uf6gwtbn6etadpvz7****
    zoneId

    string

    ID zona.

    cn-hangzhou
    securityGroupIds

    string

    ID grup keamanan.

    sg-hp35r2hc3a3sv8q2sb16
    endpoints

    array<object>

    Informasi titik akhir.

    object

    Informasi titik akhir.

    endpointType

    string

    Tipe titik akhir instans.

    Valid values:

    • TCP_VPC :

      Titik akhir VPC.

    • TCP_INTERNET :

      Titik akhir publik.

    TCP_INTERNET
    endpointUrl

    string

    Titik akhir instans.

    rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
    ipWhitelist

    array

    Daftar putih IP untuk akses jaringan publik. Hanya titik akhir publik yang mendukung konfigurasi daftar putih IP. Titik akhir 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 jaringan publik secara default.

    • Jika daftar putih IP dikonfigurasi, hanya alamat IP dalam daftar putih yang diizinkan untuk mengakses server ApsaraMQ for RocketMQ melalui jaringan publik.

    Bidang ini tidak digunakan lagi. Gunakan bidang internetInfo.ipWhitelist sebagai gantinya.

    192.168.x.x/24

    string

    Daftar putih IP untuk akses jaringan publik.

    192.168.x.x/24
    endpointId

    string

    Instans PVL EP terkait.

    ep-bpxxx
    internetInfo

    object

    Informasi jaringan publik instans.

    internetSpec

    string

    Apakah akses jaringan publik diaktifkan.

    Instans mendukung akses VPC secara default. Jika akses jaringan publik diaktifkan, ApsaraMQ for RocketMQ mengenakan biaya untuk bandwidth downstream publik. Untuk detail penagihan, lihat Biaya akses jaringan publik.

    Valid values:

    • enable :

      Akses jaringan publik diaktifkan.

    • disable :

      Akses jaringan publik dinonaktifkan.

    enable
    flowOutType

    string

    Tipe penagihan untuk akses jaringan publik.

    Valid values:

    • payByBandwidth :

      Penagihan bandwidth tetap. Tetapkan nilai ini saat akses jaringan publik diaktifkan.

    • uninvolved :

      Tidak berlaku. Tetapkan nilai ini saat akses jaringan publik tidak diaktifkan.

    payByBandwidth
    flowOutBandwidth

    integer

    Spesifikasi bandwidth Internet. Unit: Mbit/s.

    1
    ipWhitelist

    array

    Daftar putih IP untuk akses jaringan publik.

    • Jika tidak ada daftar putih IP yang dikonfigurasi, semua rentang alamat IP diizinkan untuk mengakses server ApsaraMQ for RocketMQ melalui jaringan publik secara default.

    • Jika daftar putih IP dikonfigurasi, hanya alamat IP dalam daftar putih yang diizinkan untuk mengakses server ApsaraMQ for RocketMQ melalui jaringan publik.

    string

    Daftar putih IP untuk akses jaringan publik.

    192.168.x.x/24
    accountInfo

    object

    Informasi akun.

    username

    string

    Nama pengguna instans. Saat menggunakan akses jaringan publik, konfigurasikan nama pengguna dan kata sandi instans di kode SDK untuk melakukan verifikasi identitas.

    6W0xz2uPfiwp****
    instanceQuotas

    array<object>

    Informasi kapasitas.

    object

    Informasi kapasitas.

    quotaName

    string

    Nama kuota instans.

    Valid values:

    • TOPIC_COUNT :

      Kuota pembuatan topik instans.

    TOPIC_COUNT
    usedCount

    number

    Jumlah yang digunakan.

    10
    freeCount

    number

    Kuota gratis.

    20
    totalCount

    number

    Total kuota.

    100
    createTime

    string

    Pengatur waktu pembuatan instans.

    2022-08-01 00:00:00

    updateTime

    string

    Pengatur waktu pembaruan terakhir instans.

    2022-08-02 00:00:00

    extConfig deprecated

    object

    Konfigurasi tambahan Produk. Bidang ini tidak digunakan lagi. Gunakan bidang productInfo, internetInfo, dan aclInfo sebagai gantinya.

    aclType

    string

    Tipe otentikasi instans.

    Valid values:

    • default :

      Pengenalan identitas cerdas.

    • apache_acl :

      ACL Apache RocketMQ.

    default
    sendReceiveRatio

    number

    Rasio pengiriman pesan terhadap penerimaan.

    0.5
    autoScaling

    boolean

    Apakah kapasitas elastis burstable di luar spesifikasi diaktifkan.

    Parameter ini hanya berlaku jika parameter supportAutoScaling diatur ke enable, yang berarti instans mendukung pengaktifan kapasitas elastis.

    Valid values:

    • true :

      Kapasitas elastis diaktifkan.

    • false :

      Kapasitas elastis tidak diaktifkan.

    true
    messageRetentionTime

    integer

    Periode retensi pesan. Unit: jam.

    Untuk rentang nilai, lihat Batas > Kuota Sumber daya > Periode retensi pesan.

    Penyimpanan pesan ApsaraMQ for RocketMQ sepenuhnya bersifat arsitektur tanpa server dan elastis. Biaya dikenakan berdasarkan penggunaan penyimpanan aktual. Anda dapat mengontrol kapasitas penyimpanan dengan menyesuaikan periode retensi pesan. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.

    72
    supportAutoScaling

    boolean

    Apakah instans mendukung pengaktifan kapasitas elastis burstable di luar spesifikasi.

    Setelah kapasitas elastis burstable diaktifkan, ApsaraMQ for RocketMQ mengizinkan instans melampaui batas TPS spesifikasi dasar dalam rentang tertentu. Biaya spesifikasi elastis tambahan dikenakan untuk bagian yang melampaui spesifikasi dasar. Untuk detail penagihan, lihat Biaya komputasi.

    Catatan

    Hanya instans dengan spesifikasi tertentu yang mendukung kapasitas elastis burstable. Untuk instans yang didukung, lihat Spesifikasi instans.

    Valid values:

    • true :

      Mendukung pengaktifan kapasitas elastis.

    • false :

      Tidak mendukung pengaktifan kapasitas elastis.

    true
    internetSpec

    string

    Apakah akses jaringan publik diaktifkan.

    Instans mendukung akses VPC secara default. Jika akses jaringan publik diaktifkan, ApsaraMQ for RocketMQ mengenakan biaya untuk bandwidth downstream publik. Untuk detail penagihan, lihat Biaya akses jaringan publik.

    Valid values:

    • enable :

      Akses jaringan publik diaktifkan.

    • disable :

      Akses jaringan publik dinonaktifkan.

    enable
    flowOutType

    string

    Tipe penagihan untuk akses jaringan publik.

    Valid values:

    • payByTraffic :

      Bayar sesuai lalu lintas.

    • payByBandwidth :

      Bayar sesuai bandwidth.

    • uninvolved :

      Tidak berlaku.

    payByBandwidth
    flowOutBandwidth

    integer

    Spesifikasi bandwidth Internet. Unit: Mbit/s.

    10
    msgProcessSpec

    string

    Spesifikasi pemrosesan pesan. Untuk batas atas TPS pengiriman dan penerimaan pesan, lihat Spesifikasi instans.

    rmq.s2.2xlarge
    resourceGroupId

    string

    ID kelompok sumber daya.

    rg-acfm3tmjruyribi
    productInfo

    object

    Konfigurasi tambahan instans.

    msgProcessSpec

    string

    Spesifikasi pemrosesan pesan. Untuk batas atas TPS pengiriman dan penerimaan pesan, lihat Spesifikasi instans.

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    Rasio pengiriman pesan terhadap penerimaan.

    0.5
    autoScaling

    boolean

    Apakah kapasitas elastis burstable di luar spesifikasi diaktifkan.

    Parameter ini hanya berlaku jika parameter supportAutoScaling diatur ke enable, yang berarti instans mendukung pengaktifan kapasitas elastis.

    Valid values:

    • true :

      Kapasitas elastis diaktifkan.

    • false :

      Kapasitas elastis tidak diaktifkan.

    true
    messageRetentionTime

    integer

    Periode retensi pesan. Unit: jam.

    Untuk rentang nilai, lihat Batas > Kuota Sumber daya > Periode retensi pesan.

    Penyimpanan pesan ApsaraMQ for RocketMQ sepenuhnya bersifat arsitektur tanpa server dan elastis. Biaya dikenakan berdasarkan penggunaan penyimpanan aktual. Anda dapat mengontrol kapasitas penyimpanan dengan menyesuaikan periode retensi pesan. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.

    72
    supportAutoScaling

    boolean

    Apakah instans mendukung pengaktifan kapasitas elastis burstable di luar spesifikasi.

    Setelah kapasitas elastis burstable diaktifkan, ApsaraMQ for RocketMQ mengizinkan instans melampaui batas TPS spesifikasi dasar dalam rentang tertentu. Biaya spesifikasi elastis tambahan dikenakan untuk bagian yang melampaui spesifikasi dasar. Untuk detail penagihan, lihat Biaya komputasi.

    Catatan

    Hanya instans dengan spesifikasi tertentu yang mendukung kapasitas elastis burstable. Untuk instans yang didukung, lihat Spesifikasi instans.

    Valid values:

    • true :

      Mendukung pengaktifan kapasitas elastis.

    • false :

      Tidak mendukung pengaktifan kapasitas elastis.

    true
    traceOn

    boolean

    Apakah fitur jejak pesan diaktifkan.

    • true: Fitur jejak pesan diaktifkan.

    • false: Fitur jejak pesan dinonaktifkan.

    Parameter ini tidak berlaku. Instans mendukung fitur jejak pesan secara default terlepas dari apakah parameter ini diaktifkan.

    true
    storageEncryption

    boolean

    Apakah enkripsi penyimpanan diaktifkan.

    false
    storageSecretKey

    string

    Kunci enkripsi penyimpanan.

    xxxxx
    capacityType

    string

    Mode kapasitas.

    Valid values:

    • provisioned :

      Disediakan + elastis.

    • ondemand :

      Bayar sesuai pemakaian.

    provisioned
    provisionedCapacity

    integer

    Kapasitas yang disediakan.

    3000
    drReplicationMode

    string

    Mode replikasi lintas wilayah.

    async_cross_az
    maxDelayTime

    integer

    3456000
    aclInfo

    object

    Informasi kontrol akses.

    aclTypes

    array

    Daftar tipe otentikasi untuk instans.

    string

    Tipe otentikasi instans.

    Valid values:

    • default :

      Pengenalan identitas cerdas.

    • apache_acl :

      Pengenalan identitas berbasis ACL.

    default
    defaultVpcAuthFree

    boolean

    Sakelar untuk akses bebas otentikasi melalui jaringan internal.

    Valid values:

    • true :

      Diaktifkan.

    • false :

      Dinonaktifkan.

    true
    aclType deprecated

    string

    Tipe otentikasi instans. Bidang ini tidak digunakan lagi. Gunakan bidang aclTypes sebagai gantinya.

    Valid values:

    • default :

      Pengenalan identitas cerdas.

    • apache_acl :

      Pengenalan identitas berbasis ACL.

    default
    software

    object

    Informasi perangkat lunak instans.

    softwareVersion

    string

    Versi perangkat lunak.

    5.0-rmq-20230619-1
    maintainTime deprecated

    string

    Jendela pemeliharaan untuk peningkatan.

    02:00-06:00
    upgradeMethod

    string

    Metode peningkatan.

    Valid values:

    • auto :

      Peningkatan otomatis.

    • maunal :

      Peningkatan manual.

    auto
    topicCount

    integer

    Jumlah topik.

    10
    groupCount

    integer

    Jumlah kelompok konsumen.

    10
    tags

    array<object>

    Daftar tag Sumber daya.

    object

    Tag Sumber daya.

    key

    string

    Kunci tag Sumber daya.

    key
    value

    string

    Nilai tag Sumber daya.

    value
    autoRenew

    boolean

    Apakah perpanjangan otomatis diaktifkan.

    false
    autoRenewPeriod

    integer

    Apakah perpanjangan otomatis diaktifkan.

    false
    code

    string

    Kode kesalahan.

    MissingInstanceId
    message

    string

    Paket kesalahan.

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    Kode status HTTP.

    400
    dynamicCode

    string

    Kode kesalahan dinamis.

    InstanceId
    dynamicMessage

    string

    Paket kesalahan dinamis.

    instanceId

    Contoh

    Respons sukses

    JSONformat

    {
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "test instance",
    "status": "RUNNING",
    "startTime": "2022-08-01 00:00:00",
    "expireTime": "2022-09-01 00:00:00",
    "releaseTime": "2022-09-07 00:00:00",
    "userId": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn",
    "serviceCode": "rmq",
    "seriesCode": "standard",
    "subSeriesCode": "cluster_ha",
    "paymentType": "Subscription",
    "remark": "This is remark for instance.",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou"
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx"
        }
      ],
      "internetInfo": {
        "internetSpec": "enable",
        "flowOutType": "payByBandwidth",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable",
      "flowOutType": "payByBandwidth",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge"
    },
    "resourceGroupId": "rg-acfm3tmjruyribi",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": false,
      "storageSecretKey": "xxxxx",
      "capacityType": "provisioned",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az",
      "maxDelayTime": 3456000
    },
    "aclInfo": {
      "aclTypes": [
        "default"
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default"
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto"
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "key",
        "value": "value"
      }
    ],
    "autoRenew": false,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.