Domain name for API request: cls.tencentcloudapi.com.
This API is used to get the list of log topics and supports pagination.
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-10-16. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Filters.N | No | Array of Filter | topicName filters by log topic name. Type: String. Required: NologsetName filters by logset name. Type: String. Required: NotopicId filters by log topic ID. Type: String. Required: NologsetId filters by logset ID. You can call the DescribeLogsets API to query the list of created logsets or log in to the console to view them. You can also call the CreateLogset API to create a logset. Type: String. Required: NotagKey filters by tag key. Type: String. Required: Notag:tagKey filters by tag key-value pair. The tagKey should be replaced with a specified tag key, such as “tag:exampleKey”. Type: String. Required: NostorageType filters by log topic storage type. Valid values: hot (STANDARD storage); cold : (IA storage). Type: String. Required: No. Each request can contain up to 10 Filters and 100 Filter.Values . |
Offset | No | Integer | Page offset. Default value: 0. |
Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
Topics | Array of TopicInfo | Log topic list |
TotalCount | Integer | Total number |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopics
<Common request parameters>
{
"Filters": [],
"Offset": 10,
"Limit": 30
}
{
"Response": {
"TotalCount": 1,
"Topics": [
{
"Status": true,
"TopicId": "xx",
"Tags": [
{
"Value": "xx",
"Key": "xx"
}
],
"StorageType": "xx",
"PartitionCount": 1,
"MaxSplitPartitions": 0,
"Period": 0,
"AutoSplit": true,
"TopicName": "xx",
"Index": true,
"CreateTime": "xx",
"LogsetId": "xx"
}
],
"RequestId": "xx"
}
}
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. |
FailedOperation.TagQpsLimit | The frequency of tag service requests is limited. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
MissingParameter | Missing parameter. |
OperationDenied | Operation denied. |
OperationDenied.ACLFailed | ACL verification failed. |
OperationDenied.AccountDestroy | The account has been terminated. |
OperationDenied.AccountIsolate | The account has overdue payments. |
OperationDenied.AccountNotExists | The account does not exist. |
OperationDenied.AnalysisSwitchClose | The analysis feature is not enabled for the field. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?