All Products
Search
Document Center

Data Management:GetDataExportDownloadURL

Last Updated:Nov 28, 2024

Queries the download URL of export results for a data export ticket.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:GetDataExportDownloadURLget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

3***
OrderIdlongYes

The ID of the ticket. You can call the ListOrders operation to obtain the ticket ID.

546****

Response parameters

ParameterTypeDescriptionExample
object
DownloadURLResultobject

The details about the download URL of the file that records the export results for the ticket.

HasResultboolean

Indicates whether export results are available for download. Valid values:

  • true: Export results are available for download.
  • false: No export results are available for download.
true
TipMessagestring

The message that indicates an exception.

tip message
URLstring

The download URL of the file that records the export results for the ticket.

https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip
RequestIdstring

The ID of the request.

4BF24EA5-9013-4C85-AE68-6C23AF5E0097
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "DownloadURLResult": {
    "HasResult": true,
    "TipMessage": "tip message",
    "URL": "https://dms-idb-hangzhou.oss-cn-hangzhou.aliyuncs.com/xxx.zip"
  },
  "RequestId": "4BF24EA5-9013-4C85-AE68-6C23AF5E0097",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-07-11The request parameters of the API has changedView Change Details