Get Group List - ListURocketMQGroup
Overview
Get all Groups under a RocketMQ service
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListURocketMQGroup . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ProjectId | string | Project ID. Please refer to the GetProjectList interface | Yes |
ServiceId | string | Service ID | Yes |
Limit | int | The maximum number of entries returned, (0, 1000], default is 50 entries | No |
Offset | int | Query start position, [0, ∞) | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
GroupList | array[GroupBaseInfo] | Group List Information | No |
TotalCount | int | Total Records | No |
Data Model
GroupBaseInfo
Field Name | Type | Description Information | Required |
---|---|---|---|
Id | string | Yes | |
GroupName | string | Yes | |
Remark | string | Yes | |
CreateTime | int | Yes |
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
}