All Products
Search

This Product

    Simple Log Service:CreateDownloadJob

    Document Center

    Simple Log Service:CreateDownloadJob

    Last Updated:Mar 27, 2026

    Creates a log download task in a specified project.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    POST /downloadjobs HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    project

    string

    Yes

    The name of the project.

    ali-test-project

    body

    object

    Yes

    The configuration of the log download task.

    name

    string

    Yes

    The name of the log download task.

    download-123

    description

    string

    No

    The description of the log download task.

    Log download task

    configuration

    object

    Yes

    The download configuration.

    logstore

    string

    Yes

    The source logstore.

    test-logstore

    fromTime

    integer

    Yes

    The start time, which is a UNIX timestamp that is accurate to the second.

    1722406260

    toTime

    integer

    Yes

    The end time, which is a UNIX timestamp that is accurate to the second.

    1722409860

    query

    string

    Yes

    The search statement.

    * | select *

    powerSql

    boolean

    No

    Specifies whether to enable PowerSQL.

    Valid values:

    • true :

      Yes

    • false :

      No

    true

    allowInComplete

    boolean

    Yes

    Specifies whether to allow the download of incomplete results.

    Valid values:

    • true :

      Yes

    • false :

      No

    false

    sink

    object

    Yes

    The export configuration.

    type

    string

    Yes

    The value is fixed to AliyunOSS.

    Valid values:

    • AliyunOSS :

      AliyunOSS

    AliyunOSS

    contentType

    string

    Yes

    The format of the downloaded file.

    Valid values:

    • csv :

      csv format

    • json :

      json format

    csv

    compressionType

    string

    Yes

    The compression format.

    Valid values:

    • zstd :

      zstd format

    • lz4 :

      lz4 format

    • gzip :

      gzip format

    • none :

      No compression

    none

    roleArn

    string

    No

    The Alibaba Cloud Resource Name (ARN) of the RAM role to use for the download.

    acs:ram::0123456789:role/aliyunlogdefaultrole

    bucket

    string

    No

    The Object Storage Service (OSS) bucket.

    oss-test-bucket

    prefix

    string

    No

    The prefix of the path in the destination OSS bucket.

    download/

    displayName

    string

    Yes

    The display name.

    download-123456789

    Response elements

    Element

    Type

    Description

    Example

    None defined.

    Examples

    Success response

    JSON format

    {}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    IdempotentParameterMismatch

    The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.