Call the GetUserUploadFileJob to obtain information about the task for uploading attachments.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Parameters

Parameter Type Is it required? Example Description
JobKey String Yes 65254a49100e

The task of uploading attachments requires oblecey.

Tid Long No -1

The tenant has expired.

Note The information of the tenant's chart is taken from the avatar in the upper-right corner of the system. For more information, see View tenant information .
RegionId String No cn-hangzhou

Select the service region of the destination region to call this operation. For more information about the valid values, see switchegionfigure parameter description .

Note select based on the location of the application nearby.

return data

Parameter Type Example Description
RequestId String BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD

The error message returned because the request already exists.

Success Boolean true

Whether the request is successful.

ErrorMessage String UnknownError

Error message.

ErrorCode String UnknownError

Error code.

UploadFileJobDetail object

The details of the attachment Upload task.

JobKey String 65254a4c1614235217749100e

The task of uploading attachments requires oblecey.

FileName String test.sql

The name of the file.

FileSize Long 2968269

The size of the file. unit: bytes.

FileSource String datacorrect

The purposes of file upload. values and descriptions are as follows:

  • datacorrect : data change ticket
  • order_info_attachment : ticket attachment
  • big-file : Batch Data import
  • sqlreview : supports batch operation moderation
UploadType String URL

The type of the task for uploading attachments. Valid values:

  • URL
  • OSS
UploadURL String http://xxxx/test.sql

Upload the attachment without uploading the link.

Note When UploadType parameter is URL displayed when.
UploadOSSParam object

upload attachments without uploading relevant information.

Note When UploadType parameter is OSS displayed when.
Endpoint String http://oss-cn-hangzhou.aliyuncs.com

The connection address of the destination instance instance.

BucketName String test_bucket

This operation only supports the unique identifier of a bucket.

ObjectName String test.sql

// specify the object name.

UploadedSize Long 2968269

The size of the uploaded file. unit: bytes.

JobStatus String SUCCESS

The status of the upload attachment task. the valid values and descriptions are as follows:

  • INIT : Initialization status
  • PENDING : Waits for task snatching
  • BE_SCHEDULED : to be scheduled
  • FAIL : execution failed
  • SUCCESS : execution successful
  • RUNNING : executing
JobStatusDesc String success

The description of the task status.

AttachmentKey String upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql

The returned attachment values after the attachment is uploaded. you can use the value when creating a ticket.

Examples

Sample requests


     http(s)://dms-enterprise.aliyuncs.com/? descrioblecey=65254a4c1614235217749100e&account ID=-1&common request parameters 
   

Sample success responses

XML Format


     HTTP/1.1 200 OK Content-Type:application/xml <GetUserUploadFileJobResponse> <RequestId>22FFF57C-6E85-4C3D-90AF-C1BFE79E1FAF</RequestId> <UploadFileJobDetail> <JobStatus>INIT</JobStatus> <JobKey>7000005000007000009000000</JobKey> <UploadURL>https://dbxxx.oss-cn-hangzhou.aliyuncs.com/dm/1.txt</UploadURL> <UploadedSize>0</UploadedSize> <JobStatusDesc/> <FileSource>datacorrect</FileSource> <FileName>1.txt</FileName> <UploadType>URL</UploadType> <FileSize>-1</FileSize> </UploadFileJobDetail> <Success>true</Success> </GetUserUploadFileJobResponse> 
   

JSON Format


     HTTP/1.1 200 OK Content-Type:application/json { "RequestId" : "22FFF57C-6E85-4C3D-90AF-C1BFE79E1FAF", "UploadFileJobDetail" : { "JobStatus" : "INIT", "JobKey" : "7000005000007000009000000", "UploadURL" : "https://dbxxx.oss-cn-hangzhou.aliyuncs.com/dm/1.txt", "UploadedSize" : 0, "JobStatusDesc" : "", "FileSource" : "datacorrect", "FileName" : "1.txt", "UploadType" : "URL", "FileSize" : -1 }, "Success" : true } 
   

Error code

Access error Center For more information, see error codes.