tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateTopic

Last updated: 2024-09-05 19:29:38

    1. API Description

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

    This API is used to create a topic with the full-text index and key-value index enabled by default. The creation will fail if there is no CLB exclusive logset.

    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 Params. The value used for this API: CreateTopic.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    TopicName Yes String Log topic name
    PartitionCount No Integer The number of topic partitions, which changes as partitions are split or merged. Each log topic can have up to 50 partitions. If this parameter is not passed in, 1 partition will be created by default and up to 10 partitions are allowed to be created.
    TopicType No String Log type. Valid values: ACCESS (access logs; default value) and HEALTH (health check logs).
    Period No Integer Logset retention period, in days. Default value: 30 days. Value range: [1, 3600].
    StorageType No String Log topic storage type. Valid values: hot (STANDARD storage); cold (IA storage). Default value: hot.

    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 topic

    This example shows you how to create a topic.

    Input Example

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

{
    "PartitionCount": "3",
    "TopicName": "clb-topic"
}

    Output Example

    {
    "Response": {
        "TopicId": "b046ae5f-00cf-4e90-880c-215e5ae7b6xy",
        "RequestId": "dccf2ce3-0277-465a-9c60-260cfb141d65"
    }
}

    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.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue.Duplicate Duplicate parameter value.
    InvalidParameterValue.InvalidFilter Incorrect Filter parameter.
    InvalidParameterValue.Length Wrong parameter length.
    InvalidParameterValue.Range Wrong parameter value range.
    LimitExceeded Quota exceeded.
    MissingParameter Missing parameter.
    ResourceInsufficient Insufficient resources.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy