All Products
Search
Document Center

Data Management:CreateUploadFileJob

Last Updated:Oct 21, 2024

Creates a task to upload an attachment file.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FileSourcestringYes

The purpose of the attachment file. Valid values:

  • datacorrect: The file is uploaded to change data.
  • order_info_attachment: The file is uploaded as an attachment in a ticket.
  • big-file: The file is uploaded to import multiple data records at a time.
  • sqlreview: The file is uploaded for SQL review.
datacorrect
FileNamestringYes

The name of the attachment file.

Note The file name must end with .txt or .sql. For example, the file name can be test.txt or test.sql.
test.txt
UploadURLstringYes

The URL of the attachment file. The URL must be an HTTP URL or an HTTPS URL.

Note You can upload the attachment file to an Object Storage Service (OSS) bucket and obtain the URL of the file in the OSS console. For more information, see Share objects.
https://XXX.oss-cn-hangzhou.aliyuncs.com/test.txt
TidlongNo

The ID of the tenant.

Note You can call the GetUserActiveTenant operation to query the tenant ID.
3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

E103C5F9-DE47-53F2-BF34-D71DF38F****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
ErrorMessagestring

The error message returned.

Unsupported url scheme : null, scheme must be https or http
ErrorCodestring

The error code returned.

InvalidParameterValid
JobKeystring

The key of the task.

Note You can call the GetUserUploadFileJob operation to query the progress and details of the task.
761f18031635736380812****

Examples

Sample success responses

JSONformat

{
  "RequestId": "E103C5F9-DE47-53F2-BF34-D71DF38F****",
  "Success": true,
  "ErrorMessage": "Unsupported url scheme : null, scheme must be https or http",
  "ErrorCode": "InvalidParameterValid",
  "JobKey": "761f18031635736380812****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history