All Products
Search

This Product

    Simple Log Service:CreateDownloadJob

    Document Center

    Simple Log Service:CreateDownloadJob

    Last Updated:Sep 08, 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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    log:CreateDownloadJob

    create

    *Project

    acs:log:{#regionId}:{#accountId}:project/{#project}/downloadjob/{#downloadJobName}

    		 None None

    Request syntax

    POST /downloadjobs HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    project

    string

    Yes

    The project name.

    ali-test-project

    body

    object

    Yes

    The log download task configuration.

    name

    string

    Yes

    The job name. The following naming rules apply:

    Job names must be unique within the same project.

    • The name can contain only lowercase letters, digits, hyphens (-), and underscores (_).

    • The name must start and end with a lowercase letter or digit.

    • The name must be 2 to 64 characters in length.

    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 timestamp, in seconds.

    1722406260
    toTime

    integer

    Yes

    The end timestamp, in seconds.

    1722409860
    query

    string

    Yes

    The query statement.

    * | select *
    powerSql

    boolean

    No

    Specifies whether to enable PowerSQL. Valid values: true, false.

    true
    allowInComplete

    boolean

    Yes

    Specifies whether to allow downloading inexact results. Valid values: true, false.

    false
    sink

    object

    Yes

    The export configuration.

    type

    string

    Yes

    Fixed value: AliyunOSS.

    AliyunOSS
    contentType

    string

    Yes

    The download file format. Valid values: csv, json.

    csv
    compressionType

    string

    Yes

    The compression format. Valid values: zstd, lz4, gzip, none.

    none
    roleArn

    string

    No

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

    acs:ram::0123456789:role/aliyunlogdefaultrole
    bucket

    string

    No

    The OSS bucket.

    oss-test-bucket
    prefix

    string

    No

    The path prefix in the OSS bucket to which data is downloaded.

    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.