产品动态
公告
Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to get the list of log topics and supports pagination.
A maximum of 50 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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| Filters.N | No | Array of Filter | PreciseSearch parameter to set exact match. Type: String. Required. No. PreciseSearch parameter to set exact match. Type: String. Required: No. DescribeLogsets to query the list of created logsets or log in to the console to view them. You can also call CreateLogset to create a logset. Type: String. Required: No. tagKey should be replaced with a specified tag key, such as tag:exampleKey. Type: String. Required: No. hot (standard storage) and cold (IA storage). Type: String. Required: No. Each request can have 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. |
| PreciseSearch | No | Integer | Match mode for Filters fields.- 0: Fuzzy match for topicName and logsetName. This is the default value.- 1: Exact match for topicName.- 2: Exact match for logsetName.- 3: Exact match for topicName and logsetName. |
| BizType | No | Integer | Topic type - 0 (default): Log topic. - 1: Metric topic. |
| Parameter Name | Type | Description |
|---|---|---|
| Topics | Array of TopicInfo | Log topic list |
| TotalCount | Integer | Total number |
| 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. |
This example shows you how to get the list of log topics.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopics
<Common request parameters>
{
"Filters": [],
"Offset": 10,
"Limit": 30
}{
"Response": {
"TotalCount": 1,
"Topics": [
{
"Index": true,
"PartitionCount": 1,
"Describes": "x1",
"Status": true,
"Tags": [
{
"Value": "x10",
"Key": "x11"
}
],
"AssumerName": "x12",
"SubAssumerName": "x13",
"MaxSplitPartitions": 0,
"LogsetId": "x15",
"TopicId": "x16",
"HotPeriod": 1,
"StorageType": "x17",
"Period": 0,
"AutoSplit": true,
"CreateTime": "x18",
"TopicName": "x19"
}
],
"RequestId": "x20"
}
}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. |
| ResourceNotFound.LogsetNotExist | The specified logset does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
| UnsupportedOperation | Unsupported operation. |
文档反馈