tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Message Queue
    Documentation
    Download PDF

    CreateTopic

    Last updated: 2020-05-09 10:25:44
    Download PDF

    1. API Description

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

    This API is used to create a topic.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cmq.ap-shanghai-fsi.tencentcloudapi.com

    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: 2019-03-04.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    TopicName Yes String Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (-).
    MaxMsgSize No Integer Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.
    FilterType No Integer Message match policy for a specified topic.
    MsgRetentionSeconds No Integer Message retention period. Value range: 60–86400 seconds (i.e., 1 minute–1 day). Default value: 86400.
    Trace No Boolean Whether to enable message trace. true: yes, false: no. If this field is left empty, the feature will not be enabled.

    3. Output Parameters

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

    4. Example

    Example1 Creating topic

    Input Example

    https://cmq.tencentcloudapi.com/?Action=CreateTopic
&TopicName=ConnTopic
&<Common request parameters>

    Output Example

    {
  "Response": {
    "TopicId": "topic-gzz05csc",
    "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
  }
}

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.TryLater The operation is in progress. Please try again later.
    InvalidParameter Invalid parameter.
    LimitExceeded The quota limit is exceeded.
    ResourceInUse The resource is in use.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation Unauthorized operation.
    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