tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateExport

Last updated: 2024-04-15 19:58:34

    1. API Description

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

    This API is used to create a download task. To get the returned download address, call DescribeExports to view the task list. The CosPath parameter is also included for download address. For more information, visit https://www.tencentcloud.com/document/product/614/56449.?from_cn_redirect=1

    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: CreateExport.
    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
    Count Yes Integer Number of logs to be exported. Maximum value: 50 million
    Query Yes String Search statements for log export. [SQL statements] are not supported.
    From Yes Integer Start time of the log to be exported, which is a timestamp in milliseconds
    To Yes Integer End time of the log to be exported, which is a timestamp in milliseconds
    Order No String Exported log sorting order by time. Valid values: asc: ascending; desc: descending. Default value: desc
    Format No String Exported log data format. Valid values: json, csv. Default value: json
    SyntaxRule No Integer Syntax rules; the default value is 0.0: Lucene syntax; 1: CQL syntax.

    3. Output Parameters

    Parameter Name Type Description
    ExportId String Log export 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 Export Task

    This example shows you how to create a download task. To get the returned download address, call DescribeExports to view the task list. The CosPath parameter is also included for download address.

    Input Example

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

{
    "TopicId": "ee20bb16-3025-4048-b81a-dd436373062e",
    "Query": "status:200",
    "Count": 100,
    "Order": "desc",
    "Format": "json",
    "From": 1607499107000,
    "To": 1607499207000
}

    Output Example

    {
    "Response": {
        "ExportId": "57196a6a-7622-47be-bc92-d2ebea959a0f",
        "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.TopicClosed The log topic has been disabled.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    LimitExceeded.Export The number of log export tasks has exceeded 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.TopicNotExist The log topic does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy