Docs
api
RMQ Message Queue(URocketMQ)
ListURocketMQGroup

Get Group List - ListURocketMQGroup

Overview

Get all Groups under a RocketMQ service

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListURocketMQGroup.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. Please refer to the GetProjectList interfaceYes
ServiceIdstringService IDYes
LimitintThe maximum number of entries returned, (0, 1000], default is 50 entriesNo
OffsetintQuery start position, [0, ∞)No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
GroupListarray[GroupBaseInfo]Group List InformationNo
TotalCountintTotal RecordsNo

Data Model

GroupBaseInfo

Field NameTypeDescription InformationRequired
IdstringYes
GroupNamestringYes
RemarkstringYes
CreateTimeintYes

Example

Request Example

https://api.dezai.com/?Action=ListURocketMQGroup
&Region=cn-zj
&ProjectId=uUQrxcmz
&ServiceId=XRkCLnKy
&Limit=100
&Offset=0

Response Example

{
  "Action": "ListURocketMQGroupResponse",
  "ConsumerGroupList": [
    {
      "CreateTime": 1618318932,
      "GroupName": "apzNcABI",
      "Id": "ZABVgTBC",
      "Remark": "Diuxsbmn"
    }
  ],
  "Message": "qCIwrpbX",
  "RetCode": 0,
  "TotalCount": 1
}