すべてのプロダクト
Search

このプロダクト

    :DescribeDBClusterMigration

    ドキュメントセンター

    :DescribeDBClusterMigration

    最終更新日:Dec 11, 2025

    PolarDB クラスターの移行ステータスをクエリします。

    操作説明

    • この操作では、ApsaraDB RDS for MySQL インスタンスから PolarDB for MySQL クラスターへのワンクリック移行のステータスをクエリできます。 詳細については、「ApsaraDB RDS for MySQL インスタンスの PolarDB for MySQL へのアップグレード」をご参照ください。

    • この操作を呼び出す前に、CreateDBCluster 操作を呼び出し、CreationOption パラメーターを MigrationFromRDS に設定して、クラスターのワンクリックアップグレードタスクを作成する必要があります。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeDBClusterMigration

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    pc-**************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    DBClusterEndpointList

    array<object>

    PolarDB エンドポイントの詳細。

    array<object>

    AddressItems

    array<object>

    接続文字列の詳細。

    object

    VSwitchId

    string

    vSwitch の ID。

    vsw-**********
    ConnectionString

    string

    接続文字列。

    pc-**************.rwlb.rds.aliyuncs.com
    NetType

    string

    エンドポイントのネットワークタイプ。 有効値：

    • Public：インターネットのエンドポイント。

    • Private：プライベートエンドポイント。

    • Inner：クラシックネットワーク内のプライベートエンドポイント。

    Private
    Port

    string

    ポート。

    3306
    VPCId

    string

    Virtual Private Cloud (VPC) の ID。

    vpc-**********
    IPAddress

    string

    IP アドレス。

    192.***.***.10
    SSLEnabled

    string

    Secure Sockets Layer (SSL) 暗号化が有効になっているかどうかを示します。 有効値：

    • Enabled：SSL 暗号化は有効です。

    • Disabled：SSL 暗号化は無効です。

    Enabled
    DBEndpointId

    string

    エンドポイント ID。

    pe-***********
    EndpointType

    string

    エンドポイントのタイプ。 有効値：

    • Cluster：デフォルトのクラスターエンドポイント。

    • Primary：プライマリエンドポイント。

    • Custom：カスタムクラスターエンドポイント。

    Cluster
    ReadWriteMode

    string

    読み書きモード。 有効値：

    • ReadWrite：読み書き (自動読み書き分離)。

    • ReadOnly (デフォルト)：読み取り専用。

    ReadOnly
    Comment

    string

    移行例外に関するコメント。 移行中に例外が発生しない場合は、空の値が返されます。

    test
    RequestId

    string

    リクエスト ID。

    F2A9EFA7-915F-4572-8299-85A307******
    ExpiredTime

    string

    ApsaraDB RDS インスタンスと PolarDB クラスター間のレプリケーション関係の有効期限が切れる時刻。 時刻は YYYY-MM-DDThh:mm:ssZ フォーマットで、UTC で表示されます。

    2020-06-17T01:56:36Z
    DBClusterId

    string

    クラスター ID。

    pc-****************
    Topologies

    string

    データ同期関係。 有効値：

    • RDS2POLARDB：データは ApsaraDB RDS インスタンスから PolarDB クラスターに同期されます。

    • POLARDB2RDS：データは PolarDB クラスターから ApsaraDB RDS インスタンスに同期されます。

    RDS2POLARDB
    RdsReadWriteMode

    string

    ソース ApsaraDB RDS インスタンスの読み書きモード。 有効値：

    • rw：読み書き。

    • ro：読み取り専用。

    rw
    SourceRDSDBInstanceId

    string

    ソース ApsaraDB RDS インスタンスの ID。

    rm-************
    DBClusterReadWriteMode

    string

    クラスターの読み書きモード。 有効値：

    • rw：読み書き。

    • ro：読み取り専用。

    ro
    DelayedSeconds

    integer

    ApsaraDB RDS インスタンスと PolarDB クラスター間のレプリケーション遅延 (秒単位)。

    0
    MigrationStatus

    string

    PolarDB クラスターの移行ステータス。 有効値：

    • NO_MIGRATION：移行タスクは作成されていません。

    • RDS2POLARDB_CLONING：データはクローン中です。

    • RDS2POLARDB_SYNCING：データは同期中です。 この状態では、PolarDB クラスターは読み取り専用で、ApsaraDB RDS インスタンスは読み書き可能です。

    • SWITCHING：データベースは切り替え中です。

    • POLARDB2RDS_SYNCING：データベースの切り替えが完了しました。 この状態では、PolarDB クラスターは読み書き可能で、ApsaraDB RDS インスタンスは読み取り専用です。 アプリケーションのエンドポイントを変更してください。

    • ROLLBACK：移行はロールバック中です。 ロールバックが完了すると、移行ステータスは RDS2POLARDB_SYNCING に変わります。

    • CLOSING_MIGRATION：移行タスクはシャットダウン中です。

    RDS2POLARDB_SYNCING
    DtsInstanceId

    string

    同期タスクの ID。

    dts**********618bs
    RdsEndpointList

    array<object>

    ApsaraDB RDS エンドポイントの詳細。

    array<object>

    AddressItems

    array<object>

    接続文字列の詳細。

    object

    VSwitchId

    string

    vSwitch の ID。

    vsw-**************
    ConnectionString

    string

    接続文字列。

    rm-***********.mysql.rds.aliyuncs.com
    NetType

    string

    エンドポイントのネットワークタイプ。 有効値：

    • Public：インターネットのエンドポイント。

    • Private：プライベートエンドポイント。

    • Inner：クラシックネットワーク内のプライベートエンドポイント。

    Private
    Port

    string

    ポート。

    3306
    VPCId

    string

    VPC の ID。

    vpc-************
    IPAddress

    string

    IP アドレス。

    172.***.***.173
    SSLEnabled

    string

    SSL 暗号化が有効になっているかどうかを示します。 有効値：

    • Enabled：SSL 暗号化は有効です。

    • Disabled：SSL 暗号化は無効です。

    Enabled
    DBEndpointId

    string

    エンドポイント ID。

    rm-************-normal
    EndpointType

    string

    エンドポイントのタイプ。 有効値：

    • Normal：通常のエンドポイント。

    • ReadWriteSplitting：読み書き分離エンドポイント。

    Normal
    CustinsType

    string

    インスタンスタイプ。

    ReadOnly Maxscale Primary
    SrcDbType

    string

    ソースデータベースのタイプ。 有効値：

    • PolarDBMySQL：PolarDB クラスターのメジャーバージョンアップグレードのソースデータベース。

    • RDS：ApsaraDB RDS インスタンスから PolarDB for MySQL クラスターにデータを移行するためのソースデータベース。

    PolarDBMySQL

    例

    成功レスポンス

    JSONJSON

    {
  "DBClusterEndpointList": [
    {
      "AddressItems": [
        {
          "VSwitchId": "vsw-**********",
          "ConnectionString": "pc-**************.rwlb.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "3306",
          "VPCId": "vpc-**********",
          "IPAddress": "192.***.***.10",
          "SSLEnabled": "Enabled"
        }
      ],
      "DBEndpointId": "pe-***********",
      "EndpointType": "Cluster",
      "ReadWriteMode": "ReadOnly"
    }
  ],
  "Comment": "test",
  "RequestId": "F2A9EFA7-915F-4572-8299-85A307******",
  "ExpiredTime": "2020-06-17T01:56:36Z",
  "DBClusterId": "pc-****************",
  "Topologies": "RDS2POLARDB",
  "RdsReadWriteMode": "rw",
  "SourceRDSDBInstanceId": "rm-************",
  "DBClusterReadWriteMode": "ro",
  "DelayedSeconds": 0,
  "MigrationStatus": "RDS2POLARDB_SYNCING",
  "DtsInstanceId": "dts**********618bs",
  "RdsEndpointList": [
    {
      "AddressItems": [
        {
          "VSwitchId": "vsw-**************",
          "ConnectionString": "rm-***********.mysql.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "3306",
          "VPCId": "vpc-************",
          "IPAddress": "172.***.***.173",
          "SSLEnabled": "Enabled"
        }
      ],
      "DBEndpointId": "rm-************-normal",
      "EndpointType": "Normal",
      "CustinsType": "ReadOnly\nMaxscale\nPrimary"
    }
  ],
  "SrcDbType": "PolarDBMySQL"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。