tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Log Service
    Documentation
    Download PDF

    CreateTopic

    Last updated: 2024-04-15 19:58:27
    Download PDF

      1. API Description

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

      This API is used to create a log topic.

      A maximum of 100 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 Params. The value used for this API: CreateTopic.
      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.
      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 type. Valid values: hot (STANDARD storage); cold (IA storage). Default value: hot.
      Period No Integer lifetime. Unit: days. Standard storage value range: 1 to 3600. Infrequent storage value range: 7 to 3600 days. A value of 3640 indicates permanent retention.If this value is not input, it defaults to the Period value of the log set corresponding to the accessed log topic (defaults to 30 days in case of access failure).
      Describes No String Log topic description
      HotPeriod No Integer 0: Disable log settlement.Non-zero: The number of Standard Storage days after enabling log settlement. HotPeriod needs to be greater than or equal to 7, and less than Period.Effective only when StorageType is hot.
      IsWebTracking No Boolean Authentication switch. false: off; true: on. Default is false.Once enabled, it will support specified operations for anonymous access to this log topic. For details, please see log Topic.

      3. Output Parameters

      Parameter Name Type Description
      TopicId String Log topic ID
      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.

      4. Example

      Example1 Creating a Log Topic

      This example shows you how to create a 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.
      FailedOperation.TopicCreating The topic is being created.
      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.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy