All Products
Search
Document Center

Data Management:GetDataImportSQL

Last Updated:Nov 28, 2024

Queries the SQL statements used for data import in a ticket.

Operation description

You can call this operation only if the data is imported in security mode in your data import 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:GetDataImportSQLnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ticket ID. You can call the ListOrders operation to query the ticket ID.

14****
SqlIdlongYes

The SQL ID. You can call the ListDataImportSQLPreCheckDetail operation to query the SQL ID.

15****
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID. You can use the ID to locate logs and troubleshoot issues.

B43AD641-49C2-5299-9E06-1B37EC1B****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
SQLDetailobject

The details of SQL statements.

ExecSqlstring

The SQL script.

insert into t1 values (1);

Examples

Sample success responses

JSONformat

{
  "RequestId": "B43AD641-49C2-5299-9E06-1B37EC1B****",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "SQLDetail": {
    "ExecSql": "insert into t1 values (1);"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history