Gunakan ListConsumerGroupSubscriptions untuk mencantumkan hubungan langganan untuk grup konsumen-ApsaraMQ for RocketMQ-Alibaba Cloud - ApsaraMQ for RocketMQ

Mendaftar hubungan langganan untuk kelompok konsumen.

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

list

*ConsumerGroup

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

None

Sintaks permintaan

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans ApsaraMQ for RocketMQ.	rmq-cn-tl32wwz1r05
consumerGroupId	string	Yes	ID kelompok konsumen yang hubungan langganannya ingin Anda kueri.	PRINT_RETRY_CONSUMER

Parameter permintaan

Parameter	Type	Required	Description	Example
topicName	string	No	Nama topik. Jika Anda tidak menentukan parameter ini, semua hubungan langganan akan dikueri.	topic_test

Elemen respons

Element	Type	Description	Example
	object	Result<List>
requestId	string	The request ID.	5F4D9D5F-625B-59FF-BD4F-DA8284575DB4
success	boolean	Indicates whether the request was successful.	true
data	array<object>	The data returned.
	object	The list of subscription relationships for the consumer group.
consumerGroupId	string	The ID of the consumer group.	CID-TEST
topicName	string	The topic to which the consumer group subscribes.	topic_test
messageModel	string	The consumption mode of the consumer group. BROADCASTING: The broadcast consumption mode. CLUSTERING: The cluster consumption mode.	CLUSTERING
subscriptionStatus	string	The subscription status. ONLINE: The consumer group is online. If a consumer group contains multiple consumers, the group is considered online as long as at least one consumer is online. OFFLINE: The consumer group is offline. If a consumer group contains multiple consumers, the group is considered offline only when all consumers are offline.	ONLINE
filterExpression	string	The filter expression.	*
filterExpressionType	string	The type of the filter expression. SQL: SQL filtering. TAG: Tag filtering.	SQL
topicCreated	boolean	Indicates whether the topic is created.	true
consistency	boolean	The consistency of the subscription relationship. false: The subscription relationship is inconsistent. true: The subscription relationship is consistent.	true
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	InstanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "5F4D9D5F-625B-59FF-BD4F-DA8284575DB4",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "CLUSTERING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "topicCreated": true,
      "consistency": true
    }
  ],
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.