Automate OSS File Uploads via CreateUploadOSSFileJob - Data Management - Alibaba Cloud - Data Management

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:CreateUploadOSSFileJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileSource	string	Yes	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
FileName	string	Yes	The name of the file. Note The file name must end with .txt or .sql, for example, text.txt.	test.sql
UploadTarget	object	Yes	The information about the OSS file to upload.
Endpoint	string	Yes	The endpoint of the OSS bucket.	http://oss-cn-hangzhou.aliyuncs.com
BucketName	string	Yes	The name of the OSS bucket.	test_bucket
ObjectName	string	Yes	The name of the OSS object.	test.sql
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover 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 elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	Indicates whether the request succeeded.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
JobKey	string	The key of the file upload task. You can query the upload progress and task details. For more information, see GetUserUploadFileJob.	65254a4c1614235217749100e

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.