Queries a single or all migration tasks of an ApsaraDB for RDS instance.

This operation is available only to ApsaraDB for RDS instances that are running MySQL or SQL Server. For more information about how to execute a migration task, see ImportDatabaseBetweenInstances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescibeImportsFromDatabase

The operation that you want to perform. Set the value to DescibeImportsFromDatabase.

DBInstanceId String Yes rm-bpxxxxx

The ID of the RDS instance.

EndTime String Yes 2011-06-11T16:00Z

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.

Engine String Yes MySQL

The database engine that the RDS instance runs. Valid values:

  • MySQL
  • SQLServer
StartTime String Yes 2011-06-11T15:00Z

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.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

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

ImportId Integer No 123

The ID of the single migration task you want to query.

PageSize Integer No 30

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

  • 30
  • 50
  • 100

Default value: 30.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1.

Response parameters

Parameter Type Example Description
Items Array

An array that consists of migration tasks.

ImportResultFromDB
ImportDataStatus String NotStart

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 fails.
  • 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 has stopped synchronizing data.
ImportDataStatusDescription String Description

The description of the migration task.

ImportDataType String Full

The type of the migration task. Valid values:

  • Full: The migration task migrates full data.
  • Incremental: The migration task migrates incremental data.
ImportId Integer 123

The ID of the migration task.

IncrementalImportingTime String 2011-06-11T15:00Z

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.

PageNumber Integer 1

The number of the returned page.

PageRecordCount Integer 1

The number of entries returned per page.

RequestId String B000AA91-393D-46F9-8D9B-098E28931A3A

The ID of the request.

TotalRecordCount Integer 1

The total number of entries returned.

Examples

Sample requests

http(s)://rds.aliyuncs.com/? Action=DescibeImportsFromDatabase
&DBInstanceId=rm-bpxxxxx
&EndTime=2011-06-11T16:00Z
&Engine=MySQL
&StartTime=2011-06-11T15:00Z
&<Common request parameters>

Sample success responses

XML format

<DescibeImportsFromDatabaseResponse>
  <TotalRecordCount>0</TotalRecordCount>
  <PageRecordCount>30</PageRecordCount>
  <RequestId>B000AA91-393D-46F9-8D9B-098E28931A3A</RequestId>
  <PageNumber>1</PageNumber>
  <Items>
        <ImportResultFromDB>
              <ImportId>123</ImportId>
              <ImportDataType>Full</ImportDataType>
              <ImportDataStatus>NotStart</ImportDataStatus>
              <ImportDataStatusDescription>Description</ImportDataStatusDescription>
              <IncrementalImportingTime></IncrementalImportingTime>
        </ImportResultFromDB>
  </Items>
</DescibeImportsFromDatabaseResponse>

JSON format

{
  "TotalRecordCount": 0,
  "PageRecordCount": 30,
  "RequestId": "B000AA91-393D-46F9-8D9B-098E28931A3A",
  "PageNumber": 1,
  "Items": {
    "ImportResultFromDB": [
      {
        "ImportId":"123",
        "ImportDataType":"Full",
        "ImportDataStatus":"NotStart",
        "ImportDataStatusDescription":"Description",
        "IncrementalImportingTime":""
      }
    ]
  }
}

Error codes

HTTP status code Error code Error message Description
403 OperationDenied.DBInstanceType The operation is not permitted due to type of instance. The error message returned because the operation is not supported by this type of RDS instance. Note that read-only instances cannot be cloned.

For a list of error codes, visit the API Error Center.