All Products
Search

This Product

    ApsaraMQ for RocketMQ:GetInstance

    Document Center

    ApsaraMQ for RocketMQ:GetInstance

    Last Updated:Jun 10, 2026

    Mengambil detail dari instance yang ditentukan.

    Deskripsi operasi

    Penting

    Alibaba Cloud OpenAPI adalah API manajemen yang digunakan untuk mengelola dan melakukan kueri sumber daya untuk layanan Alibaba Cloud. Kami merekomendasikan untuk mengintegrasikan OpenAPI hanya pada control plane. Jangan mengandalkan OpenAPI pada jalur data inti untuk mengirim atau menerima pesan, karena hal ini dapat menimbulkan risiko pada link 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: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 instance.

    rmq-cn-7e22ody****

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example

    Tidak ada parameter yang diperlukan.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data yang dikembalikan.

    requestId

    string

    ID permintaan. Setiap permintaan memiliki ID unik yang dapat Anda gunakan untuk memecahkan masalah.

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

    boolean

    Menunjukkan apakah permintaan berhasil.

    true
    data

    object

    Hasil yang dikembalikan.

    regionId

    string

    ID region dari instance.

    cn-hangzhou
    instanceId

    string

    ID instance.

    rmq-cn-7e22ody****
    instanceName

    string

    Nama instance.

    test instance
    status

    string

    Status instance.

    Valid values:

    • RELEASED :

      Dilepaskan

    • RUNNING :

      Sedang Berjalan

    • STOPPED :

      Dihentikan

    • CHANGING :

      Sedang Berubah

    • CREATING :

      Sedang Dibuat

    RUNNING
    startTime

    string

    Waktu saat instance dimulai.

    2022-08-01 00:00:00
    expireTime

    string

    Waktu kedaluwarsa dari instance.

    2022-09-01 00:00:00
    releaseTime

    string

    Waktu saat instance dilepaskan.

    2022-09-07 00:00:00
    userId

    string

    ID pengguna yang memiliki instance.

    111111111111111
    bid

    string

    ID bisnis (BID) dari saluran penjualan.

    26842
    commodityCode

    string

    Kode komoditas dari instance seri ApsaraMQ for RocketMQ 5.x, seperti ons_rmqsub_public_cn.

    ons_rmqsub_public_cn
    serviceCode

    string

    Kode layanan dari instance. Kode layanan untuk ApsaraMQ for RocketMQ adalah rmq.

    rmq
    seriesCode

    string

    Kode seri utama dari instance. Untuk informasi lebih lanjut tentang perbedaan antara seri utama, lihat Pemilihan produk.

    Valid values:

    • standard :

      Edisi Standar

    • shared :

      共享版

    • dedicated :

      独享版

    • ultimate :

      Edisi Platinum

    • professional :

      Edisi Profesional

    standard
    subSeriesCode

    string

    Kode sub-seri dari instance. Untuk informasi lebih lanjut tentang perbedaan antara sub-seri, lihat Pemilihan produk.

    Valid values:

    • serverless :

      serverless 版本

    • cluster_ha :

      Edisi ketersediaan tinggi

    • single_node :

      Edisi node tunggal

    cluster_ha
    paymentType

    string

    Metode penagihan dari instance.

    Valid values:

    • PayAsYouGo :

      Pay-as-you-go

    • Subscription :

      Subscription

    Subscription
    remark

    string

    Deskripsi dari instance.

    This is remark for instance.
    networkInfo

    object

    Informasi jaringan.

    vpcInfo

    object

    The VPC information.

    vpcId

    string

    The VPC ID of the instance.

    vpc-uf6of9452b2pba82c****
    vSwitchId deprecated

    string

    The vSwitch ID of the instance.

    Penting

    This parameter is deprecated. Use the vSwitches parameter instead. For compatibility, this parameter returns only one vSwitch.

    vsw-uf6gwtbn6etadpvz7****
    vSwitches

    array<object>

    The list of vSwitches.

    object

    vSwitchId

    string

    The vSwitch ID.

    vsw-uf6gwtbn6etadpvz7****
    zoneId

    string

    The zone ID.

    cn-hangzhou
    securityGroupIds

    string

    The security group ID.

    sg-hp35r2hc3a3sv8q2sb16
    endpoints

    array<object>

    The endpoint information.

    object

    The endpoint information.

    endpointType

    string

    The endpoint type of the instance.

    Valid values:

    • TCP_VPC :

      VPC endpoint

    • TCP_INTERNET :

      public endpoint

    TCP_INTERNET
    endpointUrl

    string

    The endpoint of the instance.

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

    array

    The IP address whitelist for public network access. You can configure an IP address whitelist only for public endpoints. This feature is not supported for VPC endpoints.

    • If you do not configure an IP address whitelist, access is allowed from all IP addresses by default.

    • If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the server.

    This parameter is deprecated. Use the internetInfo.ipWhitelist parameter instead.

    192.168.x.x/24

    string

    An IP address in the whitelist.

    192.168.x.x/24
    endpointId

    string

    The associated PrivateLink endpoint instance.

    ep-bpxxx
    internetInfo

    object

    The public network information of the instance.

    internetSpec

    string

    Indicates whether public network access is enabled.

    By default, instances support access over VPCs. If you enable public network access, Message Queue for Apache RocketMQ charges for outbound traffic over the public network. For more information, see Public network access fees.

    Valid values:

    • enable :

      Enables public network access.

    • disable :

      Disables public network access.

    enable
    flowOutType

    string

    The billing method for public network usage.

    Valid values:

    • payByBandwidth :

      The pay-by-bandwidth billing method. This method is used when public network access is enabled.

    • uninvolved :

      Not involved. This value is returned if public network access is disabled.

    payByBandwidth
    flowOutBandwidth

    integer

    The public bandwidth specification. Unit: Mbps.

    1
    ipWhitelist

    array

    The IP address whitelist for public network access.

    • If you do not configure an IP address whitelist, all IP addresses are allowed to access the Message Queue for Apache RocketMQ server over the public network by default.

    • If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the Message Queue for Apache RocketMQ server over the public network.

    string

    An IP address in the whitelist.

    192.168.x.x/24
    accountInfo

    object

    Informasi akun.

    username

    string

    The username for the instance. When you access an instance over the public network, you must configure the username and password in your SDK code for identity verification.

    6W0xz2uPfiwp****
    instanceQuotas

    array<object>

    Kuota dari instance.

    object

    Informasi kuota.

    quotaName

    string

    The name of the instance quota.

    Valid values:

    • TOPIC_COUNT :

      The topic quota of the instance.

    TOPIC_COUNT
    usedCount

    number

    The number of topics in use.

    10
    freeCount

    number

    The number of remaining topics that can be created.

    20
    totalCount

    number

    The total number of topics that can be created.

    100
    createTime

    string

    Waktu saat instance dibuat.

    2022-08-01 00:00:00

    updateTime

    string

    Waktu saat instance terakhir kali dimodifikasi.

    2022-08-02 00:00:00

    extConfig deprecated

    object

    Konfigurasi yang diperluas. Kami merekomendasikan Anda menggunakan parameter seperti productInfo, internetInfo, dan aclInfo sebagai pengganti parameter ini.

    aclType

    string

    The authentication type of the instance.

    Valid values:

    • default :

      intelligent identity verification

    • apache_acl :

      Apache RocketMQ ACL

    default
    sendReceiveRatio

    number

    The ratio of sent messages to received messages.

    0.5
    autoScaling

    boolean

    Indicates whether elastic scaling is enabled.

    This parameter is valid only if the supportAutoScaling parameter is set to true.

    Valid values:

    • true :

      Elastic scaling is enabled.

    • false :

      Elastic scaling is disabled.

    true
    messageRetentionTime

    integer

    The message retention period. Unit: hours.

    For the value range, see the limits on the message retention period in the "Resource quotas" section of the Limits topic.

    Message Queue for Apache RocketMQ uses a serverless storage model, and you are charged for the storage you use. You can change the retention period to manage storage costs.

    72
    supportAutoScaling

    boolean

    Indicates whether the instance supports elastic scaling.

    After you enable elastic scaling, the instance is allowed to exceed the TPS limit of the base specifications within a specific range. You are charged an extra fee for the elastic specifications that exceed the base specifications. For more information about billing, see Computing capacity fees.

    Catatan

    Only instances of specific specifications support elastic scaling. For more information, see Instance specifications.

    Valid values:

    • true :

      The instance supports elastic scaling.

    • false :

      The instance does not support elastic scaling.

    true
    internetSpec

    string

    Indicates whether public network access is enabled.

    By default, instances support access over VPCs. If you enable public network access, Message Queue for Apache RocketMQ charges for outbound traffic over the public network. For more information, see Public network access fees.

    Valid values:

    • enable :

      Public network access is enabled.

    • disable :

      Public network access is disabled.

    enable
    flowOutType

    string

    The billing method for public network usage.

    Valid values:

    • payByTraffic :

      pay-by-data-transfer

    • payByBandwidth :

      pay-by-bandwidth

    • uninvolved :

      Not involved.

    payByBandwidth
    flowOutBandwidth

    integer

    The public bandwidth specification. Unit: Mbps.

    10
    msgProcessSpec

    string

    The computing specification for sending and receiving messages. For more information about the TPS limits for sending and receiving messages, see Instance specifications.

    rmq.s2.2xlarge
    resourceGroupId

    string

    ID dari resource group.

    rg-acfm3tmjruyribi
    productInfo

    object

    Konfigurasi yang diperluas dari instance.

    msgProcessSpec

    string

    The computing specification for sending and receiving messages. For more information about the TPS limits for sending and receiving messages, see Instance specifications.

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    The ratio of sent messages to received messages.

    0.5
    autoScaling

    boolean

    Indicates whether elastic scaling is enabled.

    This parameter is valid only if the supportAutoScaling parameter is set to true.

    Valid values:

    • true :

      Elastic scaling is enabled.

    • false :

      Elastic scaling is disabled.

    true
    messageRetentionTime

    integer

    The message retention period. Unit: hours.

    For the value range, see the limits on the message retention period in the "Resource quotas" section of the Limits topic.

    Message Queue for Apache RocketMQ uses a serverless storage model, and you are charged for the storage you use. You can change the message retention period to manage storage costs. For more information, see Storage fees.

    72
    supportAutoScaling

    boolean

    Indicates whether the instance supports elastic scaling.

    After you enable elastic scaling, the instance is allowed to exceed the TPS limit of the base specifications within a specific range. You are charged an extra fee for the elastic specifications that exceed the base specifications. For more information about billing, see Computing capacity fees.

    Catatan

    Only instances of specific specifications support elastic scaling. For more information, see Instance specifications.

    Valid values:

    • true :

      The instance supports elastic scaling.

    • false :

      The instance does not support elastic scaling.

    true
    traceOn

    boolean

    Indicates whether the message trace feature is enabled.

    • true: The message trace feature is enabled.

    • false: The message trace feature is disabled.

    This parameter is not yet in effect. By default, the message trace feature is supported, regardless of whether this parameter is enabled.

    true
    storageEncryption

    boolean

    Indicates whether storage encryption is enabled.

    false
    storageSecretKey

    string

    The key for storage encryption.

    xxxxx
    capacityType

    string

    The capacity mode.

    Valid values:

    • provisioned :

      Provisioned + Elastic

    • ondemand :

      On-demand

    provisioned
    provisionedCapacity

    integer

    The provisioned capacity.

    3000
    drReplicationMode

    string

    The cross-region replication mode.

    async_cross_az
    aclInfo

    object

    Informasi kontrol akses.

    aclTypes

    array

    The authentication types of the instance.

    string

    The authentication type.

    Valid values:

    • default :

      intelligent identity verification

    • apache_acl :

      ACL-based identity verification

    default
    defaultVpcAuthFree

    boolean

    Indicates whether authentication-free access over the internal network is enabled.

    Valid values:

    • true :

      Enabled

    • false :

      Disabled

    true
    aclType deprecated

    string

    The authentication type of the instance. This parameter is deprecated. Use the aclTypes parameter instead.

    Valid values:

    • default :

      intelligent identity verification

    • apache_acl :

      ACL-based identity verification

    default
    software

    object

    Informasi perangkat lunak dari instance.

    softwareVersion

    string

    The software version.

    5.0-rmq-20230619-1
    maintainTime

    string

    The upgrade time window.

    02:00-06:00
    upgradeMethod

    string

    The upgrade method.

    Valid values:

    • auto :

      Automatic

    • maunal :

      Manual

    auto
    topicCount

    integer

    Jumlah topik.

    10
    groupCount

    integer

    Jumlah consumer group.

    10
    tags

    array<object>

    Tag-tag sumber daya.

    object

    Tag sumber daya.

    key

    string

    The key of the resource tag.

    key
    value

    string

    The value of the resource tag.

    value
    autoRenew

    boolean

    Menentukan apakah akan mengaktifkan perpanjangan otomatis.

    false
    autoRenewPeriod

    integer

    Siklus perpanjangan otomatis.

    false
    code

    string

    Kode kesalahan.

    MissingInstanceId
    message

    string

    Pesan kesalahan.

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    Kode status HTTP.

    400
    dynamicCode

    string

    Kode kesalahan dinamis.

    InstanceId
    dynamicMessage

    string

    Pesan 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"
    },
    "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.