Domain name for API request: tdmq.tencentcloudapi.com.
This API is used to get the list of topics under an environment.
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: DescribeTopics. |
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. |
EnvironmentId | Yes | String | Environment (namespace) name. |
TopicName | No | String | Fuzzy match by topic name. |
Offset | No | Integer | Offset, which defaults to 0 if left empty. |
Limit | No | Integer | The number of results to be returned, which defaults to 10 if left empty. The maximum value is 20. |
TopicType | No | Integer | Topic type description: 0: Non-persistent and non-partitioned topic; 1: Non-persistent and partitioned topic; 2: Persistent and non-partitioned topic; 3: Persistent and partitioned topic. |
ClusterId | No | String | Pulsar cluster ID. |
Filters.N | No | Array of Filter | * TopicName Query by topic name for exact search. Type: String Required: No |
TopicCreator | No | Integer | Topic creator: 1: User 2: System |
Parameter Name | Type | Description |
---|---|---|
TopicSets | Array of Topic | Array of topic sets. |
TotalCount | Integer | The number of topics. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to obtain the list of topics under the environment.
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopics
<Common request parameters>
{
"EnvironmentId": "abc",
"TopicName": "abc",
"Offset": 1,
"Limit": 1,
"TopicType": 1,
"ClusterId": "abc",
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
]
}
],
"TopicCreator": 1
}
{
"Response": {
"TotalCount": 1,
"RequestId": "abc",
"TopicSets": [
{
"PulsarTopicType": 0,
"TopicType": 1,
"ProducerCount": "abc",
"ConsumerLimit": "abc",
"ConsumerCount": "abc",
"LastLedgerCreatedTimestamp": "14578964532",
"MsgThroughputIn": "abc",
"UpdateTime": "2020-09-22 00:00:00",
"AverageMsgSize": "abc",
"Partitions": 1,
"Remark": "abc",
"LastConfirmedEntry": "abc",
"TotalSize": "1",
"NumberOfEntries": "abc",
"MsgRateOut": "abc",
"ProducerLimit": "abc",
"EnvironmentId": "abc",
"TopicName": "abc",
"MsgRateIn": "abc",
"MsgThroughputOut": "abc",
"SubTopicSets": [
{
"TopicType": 1,
"ProducerCount": "1",
"LastConfirmedEntry": "abc",
"TotalSize": "1",
"NumberOfEntries": "abc",
"ConsumerCount": "1",
"MsgRateOut": "abc",
"AverageMsgSize": "1",
"MsgThroughputIn": "abc",
"MsgRateIn": "abc",
"Partitions": 0,
"LastLedgerCreatedTimestamp": "124567885324",
"MsgThroughputOut": "abc"
}
],
"CreateTime": "2020-09-22 00:00:00"
}
]
}
}
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 |
---|---|
AuthFailure.UnauthorizedOperation | CAM authentication failed. |
InternalError.SystemError | System error. |
InvalidParameter.InvalidAdminUrl | Invalid management API address |
InvalidParameterValue.InvalidParams | The parameter value is out of the value range. |
MissingParameter.NeedMoreParams | A required parameter is missing. |
ResourceNotFound.BrokerCluster | The service cluster does not exist. |
ResourceNotFound.Cluster | The cluster does not exist. |
ResourceNotFound.Environment | The environment does not exist. |
문제 해결에 도움이 되었나요?