DescribeStructureImportTaskInfo - PolarDB - Alibaba Cloud Documentation Center

Queries the details of a database schema import task.

Operation description

The CreateDataImportTask operation creates a data import task. This operation supports importing SQL or CSV files stored in OSS or ECS, or directly provided, into a destination database instance. By specifying the instance ID, database name, engine type, data source (such as an OSS path), and import type, the system performs data write operations asynchronously or synchronously. This operation is applicable to scenarios such as data migration, initialization, and data backfill. A task ID is returned for subsequent status queries and 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

polardbx:DescribeStructureImportTaskInfo

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the instance resides.	cn-shanghai
SlinkTaskId	string	Yes	The ID of the target task.	etx-szr2rr6i*****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Message	string	The returned message. This parameter is empty when the request succeeds. When the request fails, an exception message is returned, such as an error code.	success
Data	object	The result set.
StructureImportResult	object	The import result of the schema import task.
Status	string	The import status.	finish
FinishedNum	integer	The number of completed records.	118
TotalNum	integer	The total number of results.	1
ExceptionFullTableName	string	The name of the table that encountered an exception.	hash_realtime_new.wm_in_job_et
ExceptionDetail	string	The cause of the exception.	java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement
Percentage	integer	The current progress in percentage.	100
SlinkStage	string	The slink status.	STRUCTURE_IMPORT
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Message": "success",
  "Data": {
    "StructureImportResult": {
      "Status": "finish",
      "FinishedNum": 118,
      "TotalNum": 1,
      "ExceptionFullTableName": "hash_realtime_new.wm_in_job_et",
      "ExceptionDetail": "java.sql.SQLException: [1a7a5f22aa403000][10.239.190.4:3058][hash_realtime_new]ERR-CODE: [TDDL-5123][ERR_INSTANCE_READ_ONLY_OPTION_NOT_SUPPORT] server is running with the instance-read-only option so it cannot execute this statement",
      "Percentage": 100
    },
    "SlinkStage": "STRUCTURE_IMPORT"
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.