Release Notes
Announcements
Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify a log topic.
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: ModifyTopic. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| TopicId | Yes | String | Log topic ID |
| TopicName | No | String | Log topic name |
| Tags.N | No | Array of Tag | Tag description list. This parameter is used to bind a tag to a log topic. Up to 10 tag key-value pairs are supported, and they must be unique. |
| Status | No | Boolean | Whether the topic has log collection enabled. true: collection enabled; false: collection disabled.The console currently does not support modifying this parameter. |
| AutoSplit | No | Boolean | Whether to enable automatic split |
| MaxSplitPartitions | No | Integer | Maximum number of partitions to split into for this topic if automatic split is enabled |
| Period | No | Integer | Lifecycle in days. Value range: 1 to 3600 (STANDARD storage); 7 to 3600 (IA storage). 3640 indicates permanent retention. |
| Describes | No | String | Log topic description |
| HotPeriod | No | Integer | 0: Disable log transitioning.A value other than 0: The number of STANDARD storage days after log transitioning is enabled (valid only if StorageType is hot). Note: HotPeriod should be greater than or equal to 7 and less than Period. |
| IsWebTracking | No | Boolean | Free authentication switch. false: disabled; true: enabled.Once enabled, it will support specified operations for anonymous access to this log topic. For details, please see log Topic. |
| Parameter Name | Type | Description |
|---|---|---|
| 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 modify a log topic.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTopic
<Common request parameters>
{
"TopicId": "xxxxxx-xx-xx-xx-xxxxxxxx",
"TopicName": "testname",
"Status": false,
"Tags": [],
"Period": 10
}{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}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.InvalidPeriod | The offline storage period cannot be less than 7 days. |
| FailedOperation.TagQpsLimit | The frequency of tag service requests is limited. |
| FailedOperation.TopicClosed | The log topic has been disabled. |
| FailedOperation.TopicIsolated | The log topic has been isolated. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.TopicConflict | There is already a log topic with the same name in the specified logset. |
| LimitExceeded | The quota limit has been reached. |
| 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.TopicHasScheduleSqlTask | The topic is bound to the scheduleSql job. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback