All Products
Search

This Product

    ApsaraMQ for RocketMQ:OnsConsumerGetConnection

    Document Center

    ApsaraMQ for RocketMQ:OnsConsumerGetConnection

    Last Updated:Jun 10, 2026

    Mengkueri koneksi klien dalam grup yang ditentukan.

    Deskripsi operasi

    Penting

    Alibaba Cloud OpenAPI adalah API manajemen yang digunakan untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Integrasikan API ini hanya untuk tujuan manajemen. Jangan gunakan API ini pada tautan data inti untuk mengirim dan menerima pesan. Menggunakan API ini pada tautan data inti dapat menimbulkan risiko keamanan.

    Operasi ini mengambil informasi koneksi klien dalam grup yang ditentukan ketika konsumsi pesan tidak normal. Anda kemudian dapat memeriksa status konsumen untuk mendiagnosis penyebabnya.

    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

    mq:QueryConsumerConnection

    get

    Group

    acs:mq:{#regionId}:{#accountId}:{#GroupName}

    Group

    acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

    		 None
    • mq:OnsInstanceBaseInfo

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    GroupId

    string

    Yes

    ID grup yang akan dikueri.

    GID_test_consumer_id
    InstanceId

    string

    No

    ID instance tempat grup tersebut berada.

    MQ_INST_111111111111_DOxxxxxx

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan. Ini adalah parameter umum. Setiap permintaan memiliki ID unik. Gunakan ID ini untuk memecahkan masalah.

    DE4140C7-F42D-473D-A5FF-B1E31692****
    Data

    object

    Data yang dikembalikan.

    ConnectionList

    object

    ConnectionDo

    array<object>

    The client connection information of the consumer group.

    object

    Version

    string

    The version of the consumer client.

    V4_3_6
    ClientAddr

    string

    The IP address and port number of the consumer client.

    30.5.121.**
    Language

    string

    The programming language in which the consumer application was developed.

    JAVA
    ClientId

    string

    The ID of the consumer client.

    30.5.121.**@24813#-1999745829#-1737591554#453111174894656
    MessageModel

    string

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "DE4140C7-F42D-473D-A5FF-B1E31692****",
  "Data": {
    "ConnectionList": {
      "ConnectionDo": [
        {
          "Version": "V4_3_6",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@24813#-1999745829#-1737591554#453111174894656"
        }
      ]
    },
    "MessageModel": ""
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.