DescribeDataImportTaskInfo - PolarDB - Alibaba Cloud Documentation Center

Queries the execution details of a data import task.

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:DescribeDataImportTaskInfo

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the instance resides.	cn-hangzhou
FailPageNumber	integer	No	The page number of the failed records.	1
FailPageSize	integer	No	The number of failed records to display per page.	10
SuccessPageNumber	integer	No	The page number of the successful records.	1
SuccessPageSize	integer	No	The number of successful records to display per page.	15
SlinkTaskId	string	Yes	The task ID.	etx-szr2rr6i*****

Response elements

Element	Type	Description	Example
	object
Message	string	The response message. This parameter has a value only when the task status is success. Otherwise, an empty value is returned.	success
Data	object	The result set.
DataImportTaskDetailInfo	object	The task details.
FsmId	integer	The progress ID.	1
FsmState	string	The state identifier in a data migration or synchronization task.	RECON_FINISHED_CATCH_UP
FsmStatus	string	The status in a data migration, import, or synchronization system.	IMPORT_NOT_BEGIN
ServiceDetailList	array<object>	The data import task details.
	array<object>	The data import task details.
Id	integer	The service detail ID.	1991609
Status	string	The task execution status.	FINISHED
TaskDetailList	array<object>	The task details.
	object	The task details.
Delay	integer	The delay time.	58329
LastError	string	The most recent error message.	null
PhysicalDbName	string	The physical database name.	drds_test
Progress	integer	The data import progress.	0
Statistics	string	The performance and runtime metrics collected during the execution of the data migration or import task.	{ "applyCount": 0, "cpuUseRatio": 41, "fsmId": 1, "fullGcCount": }
Status	string	The task status.	active
TaskId	integer	The task ID.	fc3b1568-ad96-****-adca-dfe018b38077
Type	string	The task type.	FULL_COPY
Type	string	Valid values: FULL_COPY: full replication. INC_COPY: incremental replication.	FULL_COPY
Code	integer	The response code. This parameter is empty when the request succeeds. If the request fails, an error message is returned, such as an error code.	200
Success	string	Indicates whether the request was successful.	true
RequestId	string	The request ID.	9B2F3840-5C98-****-B269-2D5C3A31797C

Examples

Success response

JSON format

{
  "Message": "success",
  "Data": {
    "DataImportTaskDetailInfo": {
      "FsmId": 1,
      "FsmState": "RECON_FINISHED_CATCH_UP",
      "FsmStatus": "IMPORT_NOT_BEGIN",
      "ServiceDetailList": [
        {
          "Id": 1991609,
          "Status": "FINISHED",
          "TaskDetailList": [
            {
              "Delay": 58329,
              "LastError": "null",
              "PhysicalDbName": "drds_test",
              "Progress": 0,
              "Statistics": "{\n  \"applyCount\": 0,\n  \"cpuUseRatio\": 41,\n  \"fsmId\": 1,\n  \"fullGcCount\": \n}",
              "Status": "active",
              "TaskId": 0,
              "Type": "FULL_COPY"
            }
          ],
          "Type": "FULL_COPY"
        }
      ]
    }
  },
  "Code": 200,
  "Success": "true",
  "RequestId": "9B2F3840-5C98-****-B269-2D5C3A31797C"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.