すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::DBS::RestoreTask

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::DBS::RestoreTask

    最終更新日:Mar 20, 2025

    ALIYUN::DBS::RestoreTask は、データディザスタリカバリのリストアタスクを作成するために使用されます。

    構文

    {
  "Type": "ALIYUN::DBS::RestoreTask",
  "Properties": {
    "StartTask": Boolean,
    "RestoreDir": String,
    "DuplicateConflict": String,
    "RestoreHome": String,
    "DestinationEndpointPassword": String,
    "DestinationEndpointIP": String,
    "DestinationEndpointPort": Integer,
    "DestinationEndpointOracleSID": String,
    "BackupSetId": String,
    "DestinationEndpointInstanceType": String,
    "RestoreTime": Integer,
    "DestinationEndpointRegion": String,
    "DestinationEndpointDatabaseName": String,
    "DestinationEndpointUserName": String,
    "RestoreObjects": String,
    "RestoreTaskName": String,
    "BackupPlanId": String,
    "BackupGatewayId": Integer,
    "DestinationEndpointInstanceID": String
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    StartTask

    ブール値

    いいえ

    いいえ

    リストアタスクを開始するかどうかを指定します。

    有効な値:

    • true

    • false

    DuplicateConflict

    String

    いいえ

    いいえ

    リストアタスク内のオブジェクトの名前が既存のオブジェクトと同じ名前の場合に、リストアタスクを処理する方法。

    有効な値:

    • failure (デフォルト): リストアタスクは失敗したと見なします。

    • renamenew: リストアタスク内のオブジェクトの名前を変更します。

    RestoreHome

    String

    いいえ

    いいえ

    データベースのプログラムディレクトリ。

    なし。

    DestinationEndpointPassword

    String

    いいえ

    いいえ

    パスワード。

    バックアップゲートウェイを使用して接続されている SQL Server データベースまたは Redis データベースの場合を除き、このプロパティを指定する必要があります。

    DestinationEndpointIP

    String

    いいえ

    いいえ

    データベースのエンドポイント。

    DestinationEndpointInstanceType が Express、Agent、または Other に設定されている場合、このプロパティを指定する必要があります。

    DestinationEndpointPort

    Integer

    いいえ

    いいえ

    データベースのポート。

    DestinationEndpointInstanceType が Express、Agent、Other、または ECS に設定されている場合、このプロパティを指定する必要があります。

    DestinationEndpointOracleSID

    String

    いいえ

    いいえ

    Oracle データベースのシステム ID (SID)。

    Oracle データベースの場合、このプロパティを指定する必要があります。

    BackupSetId

    String

    いいえ

    いいえ

    リストアに使用する完全バックアップセットの ID。

    BackupSetId と RestoreTime の両方を指定することはできません。

    DestinationEndpointInstanceType

    String

    はい

    いいえ

    データベースのカテゴリ。

    有効な値:

    • RDS: データベースは ApsaraDB RDS データベースです。

    • ECS: データベースは Elastic Compute Service (ECS) インスタンスにデプロイされた自己管理データベースです。

    • Express: データベースは Express Connect、VPN Gateway、または Smart Access Gateway (SAG) を使用して接続されています。

    • Agent: データベースはバックアップゲートウェイを使用して接続されています。

    • DDS: データベースは ApsaraDB for MongoDB データベースです。

    • Other: データベースはデータベースの IP アドレスとポートを使用して接続されています。

    RestoreTime

    Integer

    いいえ

    いいえ

    データをリストアする時点。

    このプロパティの値はタイムスタンプである必要があります。

    DestinationEndpointRegion

    String

    いいえ

    いいえ

    データベースのリージョン。

    DestinationEndpointInstanceType が RDS、ECS、DDS、Express、または Agent に設定されている場合、このプロパティを指定する必要があります。

    DestinationEndpointDatabaseName

    String

    いいえ

    いいえ

    データベースの名前。

    PostgreSQL または MongoDB データベースの場合、このプロパティを指定する必要があります。

    DestinationEndpointUserName

    String

    いいえ

    いいえ

    データベースへの接続に使用するアカウントのユーザー名。

    バックアップゲートウェイを使用して接続されている SQL Server データベースまたは Redis データベースの場合を除き、このプロパティを指定する必要があります。

    RestoreObjects

    String

    いいえ

    いいえ

    リストアタスクを使用してリストアするオブジェクト。

    バックアップゲートウェイを使用して接続されているデータベースの場合を除き、このプロパティを指定する必要があります。

    このプロパティの値は、次の形式である必要があります: [ { "DBName":"ソースデータベース名", "NewDBName":"宛先データベース名", "SchemaName":"ソーススキーマ名", "NewSchemaName":"宛先スキーマ名"}]。

    RestoreTaskName

    String

    はい

    いいえ

    リストアタスクの名前。

    なし。

    BackupPlanId

    String

    はい

    いいえ

    バックアップスケジュールの ID。

    なし。

    BackupGatewayId

    Integer

    いいえ

    いいえ

    バックアップゲートウェイの ID。

    DestinationEndpointInstanceType が Agent に設定されている場合、このプロパティを指定する必要があります。

    DestinationEndpointInstanceID

    String

    いいえ

    いいえ

    データベースの ID。

    DestinationEndpointInstanceType が RDS、ECS、DDS、または Express に設定されている場合、このプロパティを指定する必要があります。

    RestoreDir

    String

    いいえ

    いいえ

    リストアに使用するディレクトリ。

    DestinationEndpointInstanceType が Agent に設定されていて、バックアップスケジュールのバックアップオブジェクトが MySQL データベースの場合、このプロパティを指定する必要があります。

    戻り値

    Fn::GetAtt

    RestoreTaskId: リストアタスクの ID。

    例

    JSON 形式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "StartTask": {
      "Type": "Boolean",
      "Description": "リカバリタスクを作成するだけで、一時的にリカバリタスクを実行しません。リストアタスクを開始しないでください。", // 翻訳済み
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ],
      "Default": true
    },
    "RestoreDir": {
      "Type": "String",
      "Description": "DestinationEndpointInstanceType agent が指定されていて、バックアップスケジュールが MySQL の場合、このパラメーターは必須です。" // 翻訳済み
    },
    "DuplicateConflict": {
      "Type": "String",
      "Description": "同じ名前のオブジェクト間の競合の処理方法。有効な値:\nfailure: 同じ名前のオブジェクトは失敗します (デフォルト)。\nrenamenew: 同じ名前のオブジェクトの名前を変更します。", // 翻訳済み
      "AllowedValues": [
        "failure",
        "renamenew"
      ]
    },
    "RestoreHome": {
      "Type": "String",
      "Description": "データベースプログラムディレクトリ。" // 翻訳済み
    },
    "DestinationEndpointPassword": {
      "Type": "String",
      "Description": "RDS インスタンスにログインするために使用されるパスワード。\n注記 データベースタイプが Redis の場合、またはデータベースの場所が\nagent でデータベースタイプが MSSQL の場合は、このパラメーターを指定する必要があります。" // 翻訳済み
    },
    "DestinationEndpointIP": {
      "Type": "String",
      "Description": "データベースへの接続に使用するエンドポイント。\n注記 DestinationEndpointInstanceType が express、agent、または other の場合、このパラメーターは必須です。" // 翻訳済み
    },
    "DestinationEndpointPort": {
      "Type": "Number",
      "Description": "プライマリ MySQL サーバーのデータベースにアクセスするために使用されるポート。\n注記 DestinationEndpointInstanceType は express、agent、other、または ECS の形式です。このパラメーターは必須です。" // 翻訳済み
    },
    "DestinationEndpointOracleSID": {
      "Type": "String",
      "Description": "Oracle インスタンスの SID。\n注記 データベースタイプが Oracle の場合、このパラメーターは必須です。" // 翻訳済み
    },
    "BackupSetId": {
      "Type": "String",
      "Description": "リストアに使用する完全バックアップセットの ID。RestoreTime と相互排他です。", // 翻訳済み
      
    },
    "DestinationEndpointInstanceType": {
      "Type": "String",
      "Description": "データベースの場所。有効な値:\n- rds\n- ecs\n- express: express connect、VPN Gateway、またはスマートゲートウェイ経由で接続されたデータベース。\n- agent: バックアップゲートウェイ経由で接続されたデータベース\n- dds: ApsaraDB for MongoDB\n- kvstore\n- polardb\n- drds\n- dg: データベースは IP アドレス: ポートを介して直接接続されます。", // 翻訳済み
    },
    "RestoreTime": {
      "Type": "Number",
      "Description": "障害が復旧された時刻。値を 1554560477000 に設定します。" // 翻訳済み
    },
    "DestinationEndpointRegion": {
      "Type": "String",
      "Description": "データベースのリージョン。\n注記 DestinationEndpointInstanceType が RDS、ECS、DDS、Express、または Agent の場合、このパラメーターは必須です。" // 翻訳済み
    },
    "DestinationEndpointDatabaseName": {
      "Type": "String",
      "Description": "RDS データベースの名前。\n注記 データベースタイプが PostgreSQL または MongoDB の場合、このパラメーターは必須です。" // 翻訳済み
    },
    "DestinationEndpointUserName": {
      "Type": "String",
      "Description": "データベースアカウント。\n注記 データベースタイプが Redis の場合、またはデータベースの場所が\nagent でデータベースタイプが MSSQL の場合は、このパラメーターを指定する必要があります。" // 翻訳済み
    },
    "RestoreObjects": {
      "Type": "String",
      "Description": "オブジェクトをリストアします。\n注記 詳細については、以下の RestoreObjects を参照してください。データベースが agent にある場合、このパラメーターは他のシナリオでは必須です。" // 翻訳済み
    },
    "RestoreTaskName": {
      "Type": "String",
      "Description": "リストアタスクの名前。" // 翻訳済み
    },
    "BackupPlanId": {
      "Type": "String",
      "Description": "バックアッププランの ID。" // 翻訳済み
    },
    "BackupGatewayId": {
      "Type": "Number",
      "Description": "バックアップゲートウェイの ID。\n注記 DestinationEndpointInstanceType を agent に設定した場合、このパラメーターは必須です。" // 翻訳済み
    },
    "DestinationEndpointInstanceID": {
      "Type": "String",
      "Description": "クエリ対象の ApsaraDB RDS インスタンスの ID。\n注記 DestinationEndpointInstanceType の値が RDS、ECS、DDS、または Express の場合、このパラメーターは必須です。" // 翻訳済み
    }
  },
  "Resources": {
    "RestoreTask": {
      "Type": "ALIYUN::DBS::RestoreTask",
      "Properties": {
        "StartTask": {
          "Ref": "StartTask"
        },
        "RestoreDir": {
          "Ref": "RestoreDir"
        },
        "DuplicateConflict": {
          "Ref": "DuplicateConflict"
        },
        "RestoreHome": {
          "Ref": "RestoreHome"
        },
        "DestinationEndpointPassword": {
          "Ref": "DestinationEndpointPassword"
        },
        "DestinationEndpointIP": {
          "Ref": "DestinationEndpointIP"
        },
        "DestinationEndpointPort": {
          "Ref": "DestinationEndpointPort"
        },
        "DestinationEndpointOracleSID": {
          "Ref": "DestinationEndpointOracleSID"
        },
        "BackupSetId": {
          "Ref": "BackupSetId"
        },
        "DestinationEndpointInstanceType": {
          "Ref": "DestinationEndpointInstanceType"
        },
        "RestoreTime": {
          "Ref": "RestoreTime"
        },
        "DestinationEndpointRegion": {
          "Ref": "DestinationEndpointRegion"
        },
        "DestinationEndpointDatabaseName": {
          "Ref": "DestinationEndpointDatabaseName"
        },
        "DestinationEndpointUserName": {
          "Ref": "DestinationEndpointUserName"
        },
        "RestoreObjects": {
          "Ref": "RestoreObjects"
        },
        "RestoreTaskName": {
          "Ref": "RestoreTaskName"
        },
        "BackupPlanId": {
          "Ref": "BackupPlanId"
        },
        "BackupGatewayId": {
          "Ref": "BackupGatewayId"
        },
        "DestinationEndpointInstanceID": {
          "Ref": "DestinationEndpointInstanceID"
        }
      }
    }
  },
  "Outputs": {
    "RestoreTaskId": {
      "Description": "リストアタスクの ID。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "RestoreTask",
          "RestoreTaskId"
        ]
      }
    }
  }
}

    YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 StartTask:
  Type: Boolean
  Description: |
   リカバリタスクを作成するだけで、一時的にリカバリタスクを実行しません。
   リストアタスクを開始しないでください。
  AllowedValues:
   - 'True'
   - 'true'
   - 'False'
   - 'false'
  Default: true
 RestoreDir:
  Type: String
  Description: |
   DestinationEndpointInstanceType agent が指定されていて、バックアップスケジュールが MySQL の場合、このパラメーターは必須です。
 DuplicateConflict:
  Type: String
  Description: |
   同じ名前のオブジェクト間の競合の処理方法。
   有効な値:

   failure: 同じ名前のオブジェクトは失敗します (デフォルト)。

   renamenew: 同じ名前のオブジェクトの名前を変更します。
  AllowedValues:
   - failure
   - renamenew
 RestoreHome:
  Type: String
  Description: データベースプログラムディレクトリ。
 DestinationEndpointPassword:
  Type: String
  Description: |
   RDS インスタンスにログインするために使用されるパスワード。

   注記 データベースタイプが Redis の場合、またはデータベースの場所が

   agent でデータベースタイプが MSSQL の場合は、このパラメーターを指定する必要があります。
 DestinationEndpointIP:
  Type: String
  Description: |
   データベースへの接続に使用するエンドポイント。

   注記 DestinationEndpointInstanceType が express、agent、または other の場合、このパラメーターは必須です。
 DestinationEndpointPort:
  Type: Number
  Description: |
   プライマリ MySQL サーバーのデータベースにアクセスするために使用されるポート。

   注記 DestinationEndpointInstanceType は express、agent、other、または ECS の形式です。このパラメーターは必須です。
 DestinationEndpointOracleSID:
  Type: String
  Description: |
   Oracle インスタンスの SID。
   注記 データベースタイプが Oracle の場合、このパラメーターは必須です。
 BackupSetId:
  Type: String
  Description: |
   リストアに使用する完全バックアップセットの ID。RestoreTime と相互排他です。


 DestinationEndpointInstanceType:
  Type: String
  Description: |
   データベースの場所。有効な値:

   - rds

   - ecs

   - express: express connect、VPN Gateway、またはスマートゲートウェイ経由で接続されたデータベース。

   - agent: バックアップゲートウェイ経由で接続されたデータベース

   - dds: ApsaraDB for MongoDB

   - kvstore

   - polardb

   - drds

   - dg: データベースは IP アドレス: ポートを介して直接接続されます。
 RestoreTime:
  Type: Number
  Description: 障害が復旧された時刻。値を 1554560477000 に設定します。
 DestinationEndpointRegion:
  Type: String
  Description: |
   データベースのリージョン。

   注記 DestinationEndpointInstanceType が RDS、ECS、DDS、Express、または Agent の場合、このパラメーターは必須です。
 DestinationEndpointDatabaseName:
  Type: String
  Description: |
   RDS データベースの名前。

   注記 データベースタイプが PostgreSQL または MongoDB の場合、このパラメーターは必須です。
 DestinationEndpointUserName:
  Type: String
  Description: |
   データベースアカウント。

   注記 データベースタイプが Redis の場合、またはデータベースの場所が

   agent でデータベースタイプが MSSQL の場合は、このパラメーターを指定する必要があります。
 RestoreObjects:
  Type: String
  Description: |
   オブジェクトをリストアします。

   注記 詳細については、以下の RestoreObjects を参照してください。データベースが agent にある場合、このパラメーターは他のシナリオでは必須です。
 RestoreTaskName:
  Type: String
  Description: リストアタスクの名前。
 BackupPlanId:
  Type: String
  Description: バックアッププランの ID。
 BackupGatewayId:
  Type: Number
  Description: |
   バックアップゲートウェイの ID。

   注記 DestinationEndpointInstanceType を agent に設定した場合、このパラメーターは必須です。
 DestinationEndpointInstanceID:
  Type: String
  Description: |
   クエリ対象の ApsaraDB RDS インスタンスの ID。

   注記 DestinationEndpointInstanceType の値が RDS、ECS、DDS、または Express の場合、このパラメーターは必須です。
Resources:
 RestoreTask:
  Type: 'ALIYUN::DBS::RestoreTask'
  Properties:
   StartTask:
    Ref: StartTask
   RestoreDir:
    Ref: RestoreDir
   DuplicateConflict:
    Ref: DuplicateConflict
   RestoreHome:
    Ref: RestoreHome
   DestinationEndpointPassword:
    Ref: DestinationEndpointPassword
   DestinationEndpointIP:
    Ref: DestinationEndpointIP
   DestinationEndpointPort:
    Ref: DestinationEndpointPort
   DestinationEndpointOracleSID:
    Ref: DestinationEndpointOracleSID
   BackupSetId:
    Ref: BackupSetId
   DestinationEndpointInstanceType:
    Ref    Ref: DestinationEndpointInstanceType
   RestoreTime:
    Ref: RestoreTime
   DestinationEndpointRegion:
    Ref: DestinationEndpointRegion
   DestinationEndpointDatabaseName:
    Ref: DestinationEndpointDatabaseName
   DestinationEndpointUserName:
    Ref: DestinationEndpointUserName
   RestoreObjects:
    Ref: RestoreObjects
   RestoreTaskName:
    Ref: RestoreTaskName
   BackupPlanId:
    Ref: BackupPlanId
   BackupGatewayId:
    Ref: BackupGatewayId
   DestinationEndpointInstanceID:
    Ref: DestinationEndpointInstanceID
Outputs:
 RestoreTaskId:
  Description: リストアタスクの ID。
  Value:
   'Fn::GetAtt':
    - RestoreTask
    - RestoreTaskId