Data Management:CreateUploadFileJob - 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:CreateUploadFileJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileSource	string	Yes	The purpose of the attachment 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
FileName	string	Yes	The name of the attachment file. Note The file name must end with .txt or .sql. For example, the file name can be test.txt or test.sql.	test.txt
UploadURL	string	Yes	The URL of the attachment file. The URL must be an HTTP URL or an HTTPS URL. Note You can upload the attachment file to an Object Storage Service (OSS) bucket and obtain the URL of the file in the OSS console. For more information, see Share objects.	https://XXX.oss-cn-hangzhou.aliyuncs.com/test.txt
Tid	integer	No	The ID of the tenant. Note You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	E103C5F9-DE47-53F2-BF34-D71DF38F****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned.	Unsupported url scheme : null, scheme must be https or http
ErrorCode	string	The error code returned.	InvalidParameterValid
JobKey	string	The key of the task. Note You can call the GetUserUploadFileJob operation to query the progress and details of the task.	761f18031635736380812****

Examples

Success response

JSON format

{
  "RequestId": "E103C5F9-DE47-53F2-BF34-D71DF38F****",
  "Success": true,
  "ErrorMessage": "Unsupported url scheme : null, scheme must be https or http",
  "ErrorCode": "InvalidParameterValid",
  "JobKey": "761f18031635736380812****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.