すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::RDS::MigrateTask

最終更新日:Jun 17, 2026

Object Storage Service (OSS) から ApsaraDB RDS for SQL Server インスタンスへバックアップファイルを復元し、クラウドへのデータ移行を実行します。

構文

{
  "Type": "ALIYUN::RDS::MigrateTask",
  "Properties": {
    "IsOnlineDB": Boolean,
    "DBInstanceId": String,
    "OssObjectPositions": String,
    "CheckDBMode": String,
    "BackupMode": String,
    "DBName": String,
    "OSSUrls": String
  }
}

プロパティ

プロパティ タイプ 必須 更新可能 説明 制約
IsOnlineDB ブール値 はい いいえ 復元したデータベースをオンラインにするかどうかを指定します。 有効な値:
  • true: データベースをオンラインにします。
  • false: データベースをオンラインにしません。
説明 データベースが SQL Server 2008 R2 の場合、このパラメーターは常に true に設定されます。
DBInstanceId 文字列 はい いいえ インスタンス ID。 なし
OssObjectPositions 文字列 いいえ いいえ OSS 内のバックアップファイルの位置。 値はコロン (:) で区切られた 3 つの部分で構成されます。
  • OSS エンドポイント: oss-ap-southeast-1.aliyuncs.com
  • OSS バケット名: rdsmssqlsingapore
  • OSS 内のバックアップファイルのキー: autotest_2008R2_TestMigration_FULL.bak
説明
  • データベースが SQL Server 2008 R2 の場合、このパラメーターは使用されません。
  • データベースが SQL Server 2008 R2 より後のバージョンの場合、このパラメーターは必須です。

例: oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak

CheckDBMode 文字列 いいえ いいえ データベースをオンラインにした後に使用する整合性チェック方法。 有効な値:
  • SyncExecuteDBCheck: 同期 DB チェックを実行します。
  • AsyncExecuteDBCheck (デフォルト): 非同期 DB チェックを実行します。

    SQL Server 2008 R2 と互換性があります。

説明 このパラメーターは、IsOnlineDB パラメーターが true の場合にのみ有効です。
BackupMode 文字列 はい いいえ 移行タスクのバックアップモード。 有効な値:
  • FULL: 完全バックアップファイルからデータを復元します。
  • UPDF: 増分ファイルまたはログファイルから増分データを復元します。
DBName 文字列 はい いいえ 移行先のデータベースの名前。 なし
OSSUrls 文字列 いいえ いいえ OSS 内のバックアップファイルの共有 URL。URL は URL エンコードする必要があります。 複数の URL がある場合は、縦棒 (|) で区切り、文字列全体を URL エンコードします。
説明 データベースが SQL Server 2008 R2 の場合、このパラメーターは必須です。

戻り値

Fn::GetAtt

MigrateTaskId: 移行タスクの ID。

DBName: 移行先のデータベースの名前。

  • YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RdsId:
        Type: String
        AssociationProperty: ALIYUN::RDS::Instance::InstanceId
      DBName:
        Type: String
        Description: 復元するデータベースの名前。
    Resources:
      MigrateTask:
        Type: ALIYUN::RDS::MigrateTask
        Properties:
          IsOnlineDB: true
          DBInstanceId:
            Ref: RdsId
          BackupMode: FULL
          DBName:
            Ref: DBName
    Outputs:
      MigrateTaskId:
        Description: 移行タスクの ID。
        Value:
          Fn::GetAtt:
            - MigrateTask
            - MigrateTaskId                    
  • JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RdsId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
        },
        "DBName": {
          "Type": "String",
          "Description": "復元するデータベースの名前。"
        }
      },
      "Resources": {
        "MigrateTask": {
          "Type": "ALIYUN::RDS::MigrateTask",
          "Properties": {
            "IsOnlineDB": true,
            "DBInstanceId": {
              "Ref": "RdsId"
            },
            "BackupMode": "FULL",
            "DBName": {
              "Ref": "DBName"
            }
          }
        }
      },
      "Outputs": {
        "MigrateTaskId": {
          "Description": "移行タスクの ID。",
          "Value": {
            "Fn::GetAtt": [
              "MigrateTask",
              "MigrateTaskId"
            ]
          }
        }
      }
    }