All Products
Search

This Product

    Data Management:GetUserUploadFileJob

    Document Center

    Data Management:GetUserUploadFileJob

    Last Updated:Aug 27, 2026

    Queries the details of a file upload task.

    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

    dms:GetUserUploadFileJob

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    JobKey

    string

    Yes

    The key of the file upload task, which is returned when you call the CreateUploadFileJob or CreateUploadOSSFileJob operation.

    65254a49100e
    Tid

    integer

    No

    The tenant ID.

    Note

    To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.

    -1

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD
    Success

    boolean

    Indicates whether the request was successful.

    true
    ErrorMessage

    string

    The error message.

    UnknownError
    ErrorCode

    string

    The error code.

    UnknownError
    UploadFileJobDetail

    object

    The details of the file upload task.

    JobKey

    string

    The key of the file upload task.

    65254a4c1614235217749100e
    FileName

    string

    The name of the file.

    test.sql
    FileSize

    integer

    The size of the file. Unit: byte.

    2968269
    FileSource

    string

    The purpose of the uploaded 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
    UploadType

    string

    The upload method. Valid values:

    • URL

    • OSS

    URL
    UploadURL

    string

    The URL of the file.

    Note

    This parameter is returned if the value of UploadType is URL.

    http://xxxx/test.sql
    UploadOSSParam

    object

    The OSS bucket information for the uploaded file.

    Note

    This parameter is returned if the value of UploadType is OSS.

    Endpoint

    string

    The endpoint of the OSS bucket.

    http://oss-cn-hangzhou.aliyuncs.com
    BucketName

    string

    The name of the OSS bucket.

    test_bucket
    ObjectName

    string

    The name of the OSS object.

    test.sql
    UploadedSize

    integer

    The size of the uploaded file. Unit: byte.

    2968269
    JobStatus

    string

    The status of the file upload task. Valid values:

    • INIT: The task is initialized.

    • PENDING: The task is pending.

    • BE_SCHEDULED: The task is awaiting scheduling.

    • FAIL: The task failed.

    • SUCCESS: The task succeeded.

    • RUNNING: The task is running.

    SUCCESS
    JobStatusDesc

    string

    The status description of the file upload task.

    success
    AttachmentKey

    string

    The key of the uploaded file. You can use this key to attach the file to a ticket.

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

    Examples

    Success response

    JSON format

    {
  "RequestId": "BDEFE9F2-B3B4-42D0-83AE-ECF9FC067DCD",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "UploadFileJobDetail": {
    "JobKey": "65254a4c1614235217749100e",
    "FileName": "test.sql",
    "FileSize": 2968269,
    "FileSource": "datacorrect",
    "UploadType": "URL",
    "UploadURL": "http://xxxx/test.sql",
    "UploadOSSParam": {
      "Endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
      "BucketName": "test_bucket",
      "ObjectName": "test.sql"
    },
    "UploadedSize": 2968269,
    "JobStatus": "SUCCESS",
    "JobStatusDesc": "success",
    "AttachmentKey": "upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.