All Products
Search
Document Center

Data Management:GetDataCorrectSQLFile

Last Updated:Apr 18, 2024

Queries the download URL of the SQL script for a data change task.

Operation description

This operation applies to regular data change and batch data import.

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

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ID of the ticket.

730000
TidlongNo

The ID of the tenant.

Note : To view the ID of the tenant, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the "View information about the current tenant" section of the Manage DMS tenants.
-1

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

283C461F-11D8-48AA-B695-DF092DA32AF3
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
FileUrlstring

The download URL of the SQL script.

https://dmsxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "FileUrl": "https://dmsxxx"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history