Queries the information about a file upload task.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
JobKey | String | Yes | 65254a49100e |
The key of the file upload task. You can call the CreateUploadFileJob or CreateUploadOSSFileJob operation to query the key. |
Tid | Long | No | -1 |
The ID of the tenant. Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right
corner of the Data Management (DMS) console. For more information, see the "View information
about the current tenant" section of the Manage DMS tenants topic.
|
RegionId | String | No | cn-hangzhou |
The ID of the region in which the DMS service resides. For more information about the valid values of this parameter, see RegionID parameter. Note Set this parameter to the ID of the region that is in proximity to your applications.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD |
The ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
ErrorMessage | String | UnknownError |
The error message returned. |
ErrorCode | String | UnknownError |
The error code returned. |
UploadFileJobDetail | object |
The details of the file upload task. |
|
JobKey | String | 65254a4c1614235217749100e |
The key of the file upload task. |
FileName | String | test.sql |
The name of the file. |
FileSize | Long | 2968269 |
The size of the file. Unit: byte. |
FileSource | String | datacorrect |
The purpose of the uploaded file. Valid values:
|
UploadType | String | URL |
The method used to upload the file. Valid values:
|
UploadURL | String | http://xxxx/test.sql |
The URL of the file. Note This parameter is returned if the UploadType parameter is set to URL.
|
UploadOSSParam | object |
The information about the Object Storage Service (OSS) bucket from which the file is uploaded. Note This parameter is returned if the UploadType parameter is set to OSS.
|
|
Endpoint | String | http://oss-cn-hangzhou.aliyuncs.com |
The endpoint of the OSS bucket. |
BucketName | String | test_bucket |
The name of the OSS bucket. |
ObjectName | String | test.sql |
The name of the OSS object. |
UploadedSize | Long | 2968269 |
The size of the uploaded file. Unit: byte. |
JobStatus | String | SUCCESS |
The status of the file upload task. Valid values:
|
JobStatusDesc | String | success |
The information about the status of the file upload task. |
AttachmentKey | String | upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql |
The key of the file that is returned after the file is uploaded. You can use this key when you upload the file as an attachment in a ticket. |
Examples
Sample requests
http(s)://dms-enterprise.aliyuncs.com/?JobKey=65254a4c1614235217749100e
&Tid=-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 codes
For a list of error codes, visit the API Error Center.