- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- Message Queue Model
- Message Topic Model
- Migration Description
- Solutions and Cases
- API Documentation
- SDK
- Service Level Agreement
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- Message Queue Model
- Message Topic Model
- Migration Description
- Solutions and Cases
- API Documentation
- SDK
- Service Level Agreement
- Glossary
1. API Description
Domain name for API request: cmq.intl.tencentcloudapi.com.
This API is used to query topic details.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeTopicDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2019-03-04. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Offset | No | Integer | Starting position of queue list to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default. |
| Limit | No | Integer | Number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. |
| Filters.N | No | Array of Filter | Currently, only filtering by TopicName is supported, and only one filter value can be entered |
| TagKey | No | String | Tag match |
| TopicName | No | String | Exact match by TopicName |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | TotalCount |
| TopicSet | Array of TopicSet | TopicSet |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying topic details
Input Example
https://cmq.intl.tencentcloudapi.com/?Action=DescribeTopicDetail
&Offset=0&Limit=2
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 2,
"TopicSet": [
{
"Tags": [],
"TopicId": "topic-rga4l1o4",
"TopicName": "ConnTopic",
"CreateUin": 20548499,
"MsgRetentionSeconds": 10000,
"MaxMsgSize": 20000,
"Qps": 10000,
"FilterType": 1,
"CreateTime": 1581516588,
"LastModifyTime": 1581563581,
"MsgCount": 0
},
{
"Tags": [],
"TopicId": "topic-388k6x98",
"TopicName": "test123",
"CreateUin": 20548499,
"MsgRetentionSeconds": 86400,
"MaxMsgSize": 65536,
"Qps": 5000,
"FilterType": 1,
"CreateTime": 1581493669,
"LastModifyTime": 1581495310,
"MsgCount": 0
}
],
"RequestId": "68ebb46b-5eac-467a-9942-1a5da83a65ca"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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. |
| FailedOperation.TryLater | The operation is in progress. Please try again later. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.NoTaskId | The task ID does not exist. |
| LimitExceeded | The quota limit is exceeded. |
| ResourceInUse | The resource is in use. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
Yes
No
Was this page helpful?