CreateTopic

Last updated: 2021-11-30 16:26:21

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to create a log topic.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: CreateTopic.
Version Yes String Common parameter. The value used for this API: 2020-10-16.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LogsetId Yes String Logset ID
TopicName Yes String Log topic name
PartitionCount No Integer Number of log topic partitions. Default value: 1. Maximum value: 10
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 a resource can be bound to only one tag key.
AutoSplit No Boolean Whether to enable automatic split. Default value: true
MaxSplitPartitions No Integer Maximum number of partitions to split into for this topic if automatic split is enabled. Default value: 50
StorageType No String Log topic storage class. Valid values: hot: real-time storage; cold: offline storage. Default value: hot. If cold is passed in, please contact the customer service to add the log topic to the allowlist first.
Period No Integer Lifecycle in days. Value range: 1–366. Default value: 30

3. Output Parameters

Parameter Name Type Description
TopicId String Log topic ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating log topic

Input Example

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTopic
<Common request parameters>

{
    "LogsetId": "xxxxxx-xx-xx-xx-xxxxxxxx",
    "TopicName": "testname",
    "PartitionCount": 1,
    "Tags": [],
    "Period": 12
}

Output Example

{
  "Response": {
    "TopicId": "xxxx-xx-xx-xx-xxxxxxxx",
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
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.
LimitExceeded.Logset The number of logsets exceeds the limit.
LimitExceeded.Topic The number of log topics exceeds the limit.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound.LogsetNotExist The specified logset does not exist.