Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the list of RocketMQ topics.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeRocketMQTopics. |
Version | Yes | String | Common Params. The value used for this API: 2020-02-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
Offset | Yes | Integer | Offset for query. |
Limit | Yes | Integer | Query limit. |
ClusterId | Yes | String | Cluster ID. |
NamespaceId | Yes | String | Namespace. |
FilterType.N | No | Array of String | Filter by topic type. Valid values: Normal , GlobalOrder , PartitionedOrder , Transaction . |
FilterName | No | String | Search by topic name. Fuzzy query is supported. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The total number of query records. |
Topics | Array of RocketMQTopic | List of topic information |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tdmq.tencentcloudapi.com/?
Action=DescribeRocketMQTopics
&Offset=0
&Limit=10
&ClusterId=rocketmq-2p9vx3ax9jxg
&NamespaceId=example
&<Common request parameters>
{
"Response": {
"RequestId": "c017c4d1-13cb-4f14-ab89-2c6530892f90",
"TotalCount": 1,
"Topics": [
{
"Name": "example-topic",
"Type": "Normal",
"GroupNum": 0,
"Remark": "modified",
"PartitionNum": 3,
"CreateTime": 1621308465000,
"UpdateTime": 1621308657000
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
InternalError | Internal error. |
InternalError.IllegalMessage | Internal error. |
InvalidParameter | Incorrect parameter. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.BrokerCluster | The service cluster does not exist. |
ResourceNotFound.Cluster | The cluster does not exist. |
ResourceUnavailable | The resource is unavailable. |
Was this page helpful?