All Products
Search
Document Center

:GetConsumerStack

Last Updated:Nov 29, 2024

Queries the stack information about a consumer.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rocketmq:GetConsumerStackget
*ConsumerGroup
acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

rmq-cn-tl32upjeb08
consumerGroupIdstringYes

The consumer Group ID.

GID_TT_TASK
clientIdstringYes

The client ID.

172.26.76.48@Lqd7dImlp9KJ5V84

Response parameters

ParameterTypeDescriptionExample
object

The result.

requestIdstring

The request ID.

30F2CBC7-F69D-5D78-9661-0254C9E1FBFA
successboolean

Indicates whether the request was successful.

true
dataobject

The data returned.

regionIdstring

The region ID.

cn-hangzhou
instanceIdstring

The instance ID.

rmq-cn-7e22ody****
consumerGroupIdstring

The ID of the consumer group.

CID-TEST
stacksarray<object>

Stack Information.

stackobject

Consume stack information.

threadstring

Thread id.

123
tracksarray

Stack Information.

trackstring

Stack Information.

xxx
codestring

The error code.

Topic.NotFound
messagestring

The error message.

The instance cannot be found.
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

InstanceId
dynamicMessagestring

The dynamic error message.

instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "30F2CBC7-F69D-5D78-9661-0254C9E1FBFA",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "stacks": [
      {
        "thread": "123",
        "tracks": [
          "xxx"
        ]
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

For a list of error codes, visit the Service error codes.