Get topic list

Last updated: 2020-02-26 15:45:34

Interface description

This API (ListTopic) is used to list the list of topic under a user's account, and the data can be obtained by page.

  • Domain name requested by public network API: https://cmq-topic-{$region}.api.qcloud.com
  • Domain name requested by private network API: http://cmq-topic-{$region}.api.tencentyun.com

The above {$region} in the domain name needs to be replaced with a specific region : gz (Guangzhou), sh (Shanghai), bj (Beijing), shjr (Shanghai Financial), szjr (Shenzhen Financial), hk (China Hong Kong), cd (Chengdu), ca (North American), usw (Maxi), sg (Singapore). The region value in the common parameters should be consistent with the region value of the domain name. If there is any inconsistency, the request will be sent to the region specified by the domain name region based on the region value of the domain name.

At any time (including during internal testing), if the public network downstream Traffic is generated by using a public network domain name, Traffic and cost will be charged. Therefore, users of the service on Tencent Cloud are strongly recommended to use it. Private network Domain name, private network will not produce Traffic cost.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters page.

Parameter name Required Type Description
SearchWord No String Used to filter topic list, Backend Background uses fuzzy matching to return eligible topic list. If this parameter is left empty, all topic under the account will be returned by default.
Offset No Int When paging, this page gets the starting position of topic's list. If Enter reaches this value, Enter limit must also be required. When this value defaults, Backend Background takes the default value of 0
Limit No Int This page gets the number of topic when paging. If this parameter is not passed, the parameter defaults to 20, and the maximum value is 50.

The meanings of offset and limit are the same as those of offset and limit of SQL.

Output Parameter

Parameter name Type Description
Code Int Please see Error Codes Document
Message String Error message
RequestId String Request ID generated by the server. When an internal error occurs on the server, the user can submit this ID to Backend Background to locate the problem.
TotalCount Int The total number of topic returned by this request under the user account, rather than the number of topic obtained on this page after paging.
TopicList Array Topic list information. Each element represents a topic's information.

TopicList is defined as follows:

Parameter name Type Description
TopicId String Topic's unique logo ID
TopicName String Topic's name is unique under the same account in a single region. Topic's name is a string of no more than 64 characters, which must begin with a letter, and the rest can contain letters, numbers and underscores. -## Example

Enter:

 https://domain/v2/index.php?Action=ListTopic
 &searchWord=test
 &<Common request parameters>

Output:

{
    "code": 0,
    "message": "",
    "requestId": "14534664555",
    "totalCount": 10,
    "topicList": [{
            "topicId": "topic-asdfo",
            "topicName": "test-topic1"
        },
        {
            "topicId": "topic-asdsafo",
            "topicName": "topic-test1"
        }
    ]
}