Distributed Message Service RocketMQ

Viewing the Subscription Information of a Subscription Group

2024-07-04 06:59:06

API Introduction

Used to view the subscription information of a subscription group.

API Restrictions

None.

URl

GET       https://[endpoint]/v2/group/subDetail

Request Parameters

Request Parameters

Required or Not

Position

Parameter Type

Description

prodInstId

Yes

url

String

Instance   ID

groupName

Yes

url

String

Subscription   Group Name

Response Parameter

Response Parameter

Parameter Type

Description

statusCode

String

The   status code of the interface on the system layer. Success: 800; failure: 900.

message

String

Status   Description

returnObj

String

Return   the object. The parameters included in this parameter are described in the   comments in Response Examples.

Description of Return Value returnObj

Response Parameter

Parameter Type

Description

data

Json

Subscription   group information

Description of Return Value data

Response Parameter

Parameter Type

Description

prodInstId

String

Instance   ID

groupName

String

Subscription   Group Name

subscriptionDataMap

Map<String,   String>

Subscription   group information

KeyTopic

ValuesubString

Sample Request

GET       https://[endpoint]/v2/group/subDetail?prodInstId=70687660456281088&groupName=group

Examples of a Successful Response

{

    "returnObj":{

        "data":{

            "prodInstId":"mq_test",

            "groupName":"group",

            "subscriptionDataMap":{

                "%RETRY%group":"*",

                "test":"*"

            }

        }

    },

    "message":"success",

    "statusCode":800

}

Example of a Failed Response

{

    "returnObj": {},

    "message": "...",

    "statusCode": "900"

}


JzCrvq2jTlO2