CreateDBExportTask-阿里云帮助中心

Operation description

Note

After you successfully create an export task, you can call the QueryDBExportTaskStatus operation to query the status of the export task. After the data is exported, a URL is returned for you to download the exported file.

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

mpserverless:CreateDBExportTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SpaceId	string	Yes	The ID of the workspace.	0e16bb12-14af-4635-b24c-5ac1a9a*****
Collection	string	Yes	The name of the collection.	article
FileType	string	Yes	The type of the exported file. Valid values: JSON CSV	CSV
Fields	string	No	The list of fields to export, separated by commas (,). This parameter is required when the file type is CSV.	name,content

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The ID of the task.	0150006d-ab93-4920-a63e-c011dea1e089

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "0150006d-ab93-4920-a63e-c011dea1e089"
}

Error codes

HTTP status code	Error code	Error message	Description
400	AccessDenied	You are not authorized to access this space.	You are not authorized to access the specified workspace.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.