Help Center> Data Lake Insight> API Reference> APIs Related to SQL Jobs> APIs Related to Data Download> Creating a Data Download Job
View PDF

Creating a Data Download Job

Function

This API is used to create a data download job. This API is used to create a bucket that grants permissions to a user in DLI and return the bucket name.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v1/{project_id}/downloaders

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

None

Response

Table 2 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Indicates whether the request is successfully sent. Value true indicates that the request is successfully sent.

message

No

String

System prompt. If execution succeeds, the parameter setting may be left blank.

bucket_name

No

String

Name of the bucket to which the user grants permissions.

Example

  • Example request 
    None
  • Example response (successful request) 
    {
    "is_success": true,
    "message": "create download job success",
    "bucket_name": "dli-upload-cn-north-4-011c99axxxxx4a1bb9xxxxx7637d3fd"
}

Status Codes

Table 3 describes the status code.

Table 3 Status codes

Status Code

Description

200

The job is created successfully.

400

Request error.

500

Internal service error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.