All Products
Search
Document Center

ApsaraDB RDS:DescibeImportsFromDatabase

Last Updated:Aug 28, 2026

Queries the migration tasks of an instance.

Operation description

Supported database engines

  • MySQL

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
Operation Access level Resource type Condition key Associated operation
rds:DescibeImportsFromDatabase list
*DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    none
none

Request parameters

Parameter Type Required Description Example
ClientToken string No

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCzxxxxxxx
DBInstanceId string Yes

The instance ID. You can call the DescribeDBInstances operation to query the IDs of instances.

rm-bpxxxxx
Engine string Yes

The database engine of the instance. Set the value to MySQL

MySQL
ImportId integer No

The ID of the migration task.

123
StartTime string Yes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2011-06-11T15:00Z
EndTime string Yes

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2011-06-11T16:00Z
PageSize integer No

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumber integer No

The page number. Valid values: any non-zero positive integer.

Default value: 1.

1
ResourceGroupId string No

The ID of the resource group. You can call the DescribeDBInstanceAttribute operation to obtain the ID of the resource group.

rg-acfmy*****

Response parameters

Parameter Type Description Example
object

The response parameters.

RequestId string

The request ID.

B000AA91-393D-46F9-8D9B-098E28931A3A
PageNumber integer

The page number.

1
PageRecordCount integer

The number of entries per page.

1
TotalRecordCount integer

The total number of entries returned.

1
Items array<object>

The migration tasks.

ImportResultFromDB object
IncrementalImportingTime string

The time when the migration task synchronized incremental data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2011-06-11T15:00Z
ImportId integer

The ID of the migration task.

123
ImportDataStatus string

The status of the migration task. Valid values:

  • NotStart: The migration task has not started.
  • FullExporting: The migration task is exporting full data.
  • FullImporting: The migration task is importing full data.
  • Success: The migration task is successful.
  • Failed: The migration task failed.
  • Canceled: The migration task is canceled.
  • Canceling: The migration task is being canceled.
  • IncrementalWaiting: The migration task is waiting to synchronize incremental data.
  • IncrementalImporting: The migration task is synchronizing incremental data.
  • StopSyncing: The migration task stops synchronizing data.
NotStart
ImportDataType string

The type of the migration task. Valid values:

  • Full: full migration
  • Incremental:: incremental migration
Full
ImportDataStatusDescription string

The description of the migration task.

Description

Examples

Sample success responses

JSONformat

{
  "RequestId": "B000AA91-393D-46F9-8D9B-098E28931A3A",
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "Items": {
    "ImportResultFromDB": [
      {
        "IncrementalImportingTime": "2011-06-11T15:00Z",
        "ImportId": 123,
        "ImportDataStatus": "NotStart",
        "ImportDataType": "Full",
        "ImportDataStatusDescription": "Description\n"
      }
    ]
  }
}

Error codes

HTTP status code Error code Error message Description
400 InvalidMigrationType.Format Specified migration type is not valid. -
400 InvalidPageNumbers.Malformed Specified page number is not valid. The page number cannot be found.
400 ParameterLeastAssociate Must input at least one optional parameter You must enter at least one selectable parameter.
400 InvalidParameterCombination The end time must be greater than the start time The end time must be later than the start time.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. A package instance is not allowed to operate independently.
400 Price.PricingPlanResultNotFound Pricing plan price result not found. Pricing plan price result not found.
400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
403 OperationDenied.DBInstanceType The operation is not permitted due to type of instance. -
403 InvalidMaxRecordsPerPage.Malformed Specified record number is not valid. -
404 InvalidDBInstanceName.NotFound Invalid DBInstanceId NotFound. The instance ID cannot be found.
404 InvalidDBInstance.NotFound Specified instance does not exist or not support. The RDS instance cannot be found, is deleted, or does not support the operation.

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

Change history

Change time Summary of changes Operation
2023-11-06 API Description Update. The Error code has changed View Change Details
2023-07-25 The Error code has changed. The request parameters of the API has changed View Change Details