All Products
Search
Document Center

Data Management:CreateUploadOSSFileJob

Last Updated:Feb 27, 2024

Creates a task to upload an Object Storage Service (OSS) file and obtain the key of the task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:CreateUploadOSSFileJobRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSourcestringYes

The purpose of the file upload task. 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 file.

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

The information about the OSS file to be uploaded.

EndpointstringYes

The endpoint of the OSS bucket.

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

The name of the OSS bucket.

test_bucket
ObjectNamestringYes

The name of the OSS object.

test.sql
TidlongNo

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.
-1

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Successboolean

Indicates whether the request was successful.

true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
JobKeystring

The key of the file upload task. You can query the upload progress and task details. For more information, see GetUserUploadFileJob .

65254a4c1614235217749100e

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "JobKey": "65254a4c1614235217749100e"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history