All Products
Search
Document Center

:ListTopicSubscriptions

Last Updated:Sep 24, 2024

Queries the subscriptions of a topic.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListTopicSubscriptionslist
  • Topic
    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}
    none
none

Request syntax

GET /instances/{instanceId}/topics/{topicName}/subscriptions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The ID of the ApsaraMQ for RocketMQ instance.

rmq-cn-zpr34udri0w
topicNamestringNo

The name of the topic on the ApsaraMQ for RocketMQ instance.

dev4-HMH_INSURANCE_NOMAL_TOPIC

Response parameters

ParameterTypeDescriptionExample
object

Result<List>

requestIdstring

The request ID.

92A9BE4E-B794-50C8-979C-0456E4D32943
successboolean

Indicates whether the request was successful.

true
dataarray<object>

The returned data.

dataobject

The subscriptions of the topic.

consumerGroupIdstring

The consumer group ID.

CID-TEST
topicNamestring

The topic name.

topic_test
messageModelstring

The consumption mode. Valid values: BROADCASTING and CLUSTERING.

BROADCASTING
subscriptionStatusstring

The subscription status. Valid values: ONLINE and OFFLINE.

ONLINE
filterExpressionstring

The filter expression.

*
filterExpressionTypestring

The type of the filter expression. Valid values: SQL, TAG, and UNSPECIFIED. The value SQL indicates that messages are filtered by using SQL expressions. The value TAG indicates that messages are filtered by using tags. The value UNSPECIFIED indicates that no filter expression type is specified.

SQL
consistencystring

Indicates whether message consumption is consistent. Valid values:

  • false: Unconsumed messages exist in the consumer group.
  • true: No unconsumed message exists in the consumer group.
true
codestring

The error code.

MissingInstanceId
messagestring

The error message.

The instance cannot be found.
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

Topic
dynamicMessagestring

The dynamic error message.

instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "92A9BE4E-B794-50C8-979C-0456E4D32943",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "BROADCASTING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "consistency": "true"
    }
  ],
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "Topic",
  "dynamicMessage": "instanceId"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-09-09The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-05-28The response structure of the API has changedView Change Details