全部产品
Search
文档中心

Resource Orchestration Service:ALIYUN::DBS::RestoreTask

更新时间:Jun 26, 2025

ALIYUN::DBS::RestoreTask digunakan untuk membuat tugas pemulihan Data Disaster Recovery.

Sintaksis

{
  "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
  }
}

Properti

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Kendala

StartTask

Boolean

Tidak

Tidak

Menentukan apakah akan memulai tugas pemulihan.

Nilai yang valid:

  • true

  • false

DuplicateConflict

String

Tidak

Tidak

Metode yang digunakan untuk menangani tugas pemulihan ketika objek dalam tugas pemulihan memiliki nama yang sama dengan objek yang sudah ada.

Nilai yang valid:

  • failure (default): menganggap tugas pemulihan gagal.

  • renamenew: mengganti nama objek dalam tugas pemulihan.

RestoreHome

String

Tidak

Tidak

Direktori program database.

Tidak ada.

DestinationEndpointPassword

String

Tidak

Tidak

Kata sandi.

Properti ini harus ditentukan kecuali untuk database SQL Server yang terhubung menggunakan gateway cadangan atau database Redis.

DestinationEndpointIP

String

Tidak

Tidak

Titik akhir database.

Properti ini harus ditentukan ketika DestinationEndpointInstanceType diatur ke Express, Agent, atau Other.

DestinationEndpointPort

Integer

Tidak

Tidak

Port database.

Properti ini harus ditentukan ketika DestinationEndpointInstanceType diatur ke Express, Agent, Other, atau ECS.

DestinationEndpointOracleSID

String

Tidak

Tidak

ID sistem (SID) dari database Oracle.

Properti ini harus ditentukan untuk database Oracle.

BackupSetId

String

Tidak

Tidak

ID set cadangan penuh yang digunakan untuk pemulihan.

Anda tidak dapat menentukan keduanya BackupSetId dan RestoreTime.

DestinationEndpointInstanceType

String

Ya

Tidak

Kategori database.

Nilai yang valid:

  • RDS: Database adalah database ApsaraDB RDS.

  • ECS: Database adalah database mandiri yang ditempatkan pada instance Elastic Compute Service (ECS).

  • Express: Database terhubung menggunakan Express Connect, VPN Gateway, atau Smart Access Gateway (SAG).

  • Agent: Database terhubung menggunakan gateway cadangan.

  • DDS: Database adalah database ApsaraDB for MongoDB.

  • Other: Database terhubung menggunakan alamat IP dan port database.

RestoreTime

Integer

Tidak

Tidak

Titik waktu ke mana Anda ingin memulihkan data.

Nilai properti ini harus berupa timestamp.

DestinationEndpointRegion

String

Tidak

Tidak

Wilayah database.

Properti ini harus ditentukan ketika DestinationEndpointInstanceType diatur ke RDS, ECS, DDS, Express, atau Agent.

DestinationEndpointDatabaseName

String

Tidak

Tidak

Nama database.

Properti ini harus ditentukan untuk database PostgreSQL atau MongoDB.

DestinationEndpointUserName

String

Tidak

Tidak

Nama pengguna akun yang digunakan untuk terhubung ke database.

Properti ini harus ditentukan kecuali untuk database SQL Server yang terhubung menggunakan gateway cadangan atau database Redis.

RestoreObjects

String

Tidak

Tidak

Objek yang ingin Anda pulihkan menggunakan tugas pemulihan.

Properti ini harus ditentukan kecuali untuk database yang terhubung menggunakan gateway cadangan.

Nilai properti ini harus dalam format berikut: [ { "DBName":"Nama database sumber", "NewDBName":"Nama database tujuan", "SchemaName":"Nama skema sumber", "NewSchemaName":"Nama skema tujuan"}].

RestoreTaskName

String

Ya

Tidak

Nama tugas pemulihan.

Tidak ada.

BackupPlanId

String

Ya

Tidak

ID jadwal cadangan.

Tidak ada.

BackupGatewayId

Integer

Tidak

Tidak

ID gateway cadangan.

Properti ini harus ditentukan ketika DestinationEndpointInstanceType diatur ke Agent.

DestinationEndpointInstanceID

String

Tidak

Tidak

ID database.

Properti ini harus ditentukan ketika DestinationEndpointInstanceType diatur ke RDS, ECS, DDS, atau Express.

RestoreDir

String

Tidak

Tidak

Direktori yang digunakan untuk pemulihan.

Properti ini harus ditentukan ketika DestinationEndpointInstanceType diatur ke Agent dan objek cadangan dari jadwal cadangan adalah database MySQL.

Nilai Pengembalian

Fn::GetAtt

RestoreTaskId: ID tugas pemulihan.

Contoh

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "StartTask": {
      "Type": "Boolean",
      "Description": "Hanya buat tugas pemulihan dan tidak lakukan tugas pemulihan untuk sementara. Jangan mulai tugas pemulihan.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ],
      "Default": true
    },
    "RestoreDir": {
      "Type": "String",
      "Description": "DestinationEndpointInstanceType parameter ini diperlukan ketika agent ditentukan dan jadwal cadangan adalah MySQL."
    },
    "DuplicateConflict": {
      "Type": "String",
      "Description": "Metode penanganan untuk konflik antara objek dengan nama yang sama. Nilai yang valid:\nfailure: Objek dengan nama yang sama gagal (default).\nrenamenew: mengganti nama objek dengan nama yang sama.",
      "AllowedValues": [
        "failure",
        "renamenew"
      ]
    },
    "RestoreHome": {
      "Type": "String",
      "Description": "Direktori Program Database."
    },
    "DestinationEndpointPassword": {
      "Type": "String",
      "Description": "Kata sandi yang digunakan untuk masuk ke instance RDS.\nCatatan Anda harus menentukan parameter ini ketika tipe database adalah Redis, atau lokasi database\nadalah agent dan tipe database adalah MSSQL."
    },
    "DestinationEndpointIP": {
      "Type": "String",
      "Description": "Titik akhir yang digunakan untuk terhubung ke database.\nCatatan DestinationEndpointInstanceType adalah express, agent, atau other. Parameter ini diperlukan."
    },
    "DestinationEndpointPort": {
      "Type": "Number",
      "Description": "Port yang digunakan untuk mengakses database server MySQL utama.\nCatatan DestinationEndpointInstanceType dalam format express, agent, other, atau ECS. Parameter ini diperlukan."
    },
    "DestinationEndpointOracleSID": {
      "Type": "String",
      "Description": "SID dari instance Oracle.\nCatatan Parameter ini diperlukan jika tipe database adalah Oracle."
    },
    "BackupSetId": {
      "Type": "String",
      "Description": "ID set cadangan penuh yang digunakan untuk pemulihan, yang saling eksklusif dengan\nRestoreTime."
    },
    "DestinationEndpointInstanceType": {
      "Type": "String",
      "Description": "Lokasi database. Nilai yang valid: \n- rds \n- ecs \n- express: database terhubung melalui express connect, VPN Gateway, atau smart gateway. \n- agent: Database terhubung melalui backup Gateway \n- dds: apsaradb for MongoDB \n- kvstore \n- polardb \n- drds \n- dg: database langsung terhubung melalui Alamat IP: Port."
    },
    "RestoreTime": {
      "Type": "Number",
      "Description": "Waktu ketika kesalahan dipulihkan. Atur nilainya menjadi 1554560477000."
    },
    "DestinationEndpointRegion": {
      "Type": "String",
      "Description": "Wilayah database.\nCatatan DestinationEndpointInstanceType untuk RDS, ECS, DDS, Express, atau Agent, parameter ini diperlukan."
    },
    "DestinationEndpointDatabaseName": {
      "Type": "String",
      "Description": "Nama database RDS.\nCatatan Ketika tipe database adalah PostgreSQL atau MongoDB, parameter ini diperlukan."
    },
    "DestinationEndpointUserName": {
      "Type": "String",
      "Description": "Akun database.\nCatatan Anda harus menentukan parameter ini ketika tipe database adalah Redis, atau lokasi database\nadalah agent dan tipe database adalah MSSQL."
    },
    "RestoreObjects": {
      "Type": "String",
      "Description": "Pulihkan sebuah objek.\nCatatan Untuk detailnya, lihat RestoreObjects berikut jika database berada di agent, parameter ini diperlukan dalam skenario lain."
    },
    "RestoreTaskName": {
      "Type": "String",
      "Description": "Nama tugas pemulihan."
    },
    "BackupPlanId": {
      "Type": "String",
      "Description": "ID rencana cadangan."
    },
    "BackupGatewayId": {
      "Type": "Number",
      "Description": "ID gateway cadangan.\nCatatan DestinationEndpointInstanceType jika Anda menetapkan parameter ini ke agent, parameter ini diperlukan."
    },
    "DestinationEndpointInstanceID": {
      "Type": "String",
      "Description": "ID instance ApsaraDB RDS untuk kueri.\nCatatan DestinationEndpointInstanceType jika nilainya adalah RDS, ECS, DDS, atau Express, parameter ini diperlukan."
    }
  },
  "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 tugas pemulihan.",
      "Value": {
        "Fn::GetAtt": [
          "RestoreTask",
          "RestoreTaskId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 StartTask:
  Type: Boolean
  Description: >-
   Hanya buat tugas pemulihan dan tidak lakukan tugas pemulihan untuk sementara.
   Jangan mulai tugas pemulihan.
  AllowedValues:
   - 'True'
   - 'true'
   - 'False'
   - 'false'
  Default: true
 RestoreDir:
  Type: String
  Description: >-
   DestinationEndpointInstanceType parameter ini diperlukan ketika agent
   ditentukan dan jadwal cadangan adalah MySQL.
 DuplicateConflict:
  Type: String
  Description: >-
   Metode penanganan untuk konflik antara objek dengan nama yang sama.
   Nilai yang valid:

   failure: Objek dengan nama yang sama gagal (default).

   renamenew: mengganti nama objek dengan nama yang sama.
  AllowedValues:
   - failure
   - renamenew
 RestoreHome:
  Type: String
  Description: Direktori Program Database.
 DestinationEndpointPassword:
  Type: String
  Description: >-
   Kata sandi yang digunakan untuk masuk ke instance RDS.

   Catatan Anda harus menentukan parameter ini ketika tipe database adalah Redis, atau
   lokasi database

   adalah agent dan tipe database adalah MSSQL.
 DestinationEndpointIP:
  Type: String
  Description: >-
   Titik akhir yang digunakan untuk terhubung ke database.

   Catatan DestinationEndpointInstanceType adalah express, agent, atau other. Parameter ini
   diperlukan.
 DestinationEndpointPort:
  Type: Number
  Description: >-
   Port yang digunakan untuk mengakses database server MySQL utama.

   Catatan DestinationEndpointInstanceType dalam format express, agent,
   other, atau ECS. Parameter ini diperlukan.
 DestinationEndpointOracleSID:
  Type: String
  Description: |-
   SID dari instance Oracle.
   Catatan Parameter ini diperlukan jika tipe database adalah Oracle.
 BackupSetId:
  Type: String
  Description: >-
   ID set cadangan penuh yang digunakan untuk pemulihan, yang saling
   eksklusif dengan

   RestoreTime.
 DestinationEndpointInstanceType:
  Type: String
  Description: >-
   Lokasi database. Nilai yang valid:

   - rds

   - ecs

   - express: database terhubung melalui express connect, VPN Gateway, atau
   smart gateway.

   - agent: Database terhubung melalui backup Gateway

   - dds: apsaradb for MongoDB

   - kvstore

   - polardb

   - drds

   - dg: database langsung terhubung melalui Alamat IP: Port.
 RestoreTime:
  Type: Number
  Description: Waktu ketika kesalahan dipulihkan. Atur nilainya menjadi 1554560477000.
 DestinationEndpointRegion:
  Type: String
  Description: >-
   Wilayah database.

   Catatan DestinationEndpointInstanceType untuk RDS, ECS, DDS, Express, atau Agent,
   parameter ini diperlukan.
 DestinationEndpointDatabaseName:
  Type: String
  Description: >-
   Nama database RDS.

   Catatan Ketika tipe database adalah PostgreSQL atau MongoDB, parameter ini
   diperlukan.
 DestinationEndpointUserName:
  Type: String
  Description: >-
   Akun database.

   Catatan Anda harus menentukan parameter ini ketika tipe database adalah Redis, atau
   lokasi database

   adalah agent dan tipe database adalah MSSQL.
 RestoreObjects:
  Type: String
  Description: >-
   Pulihkan sebuah objek.

   Catatan Untuk detailnya, lihat RestoreObjects berikut jika database berada di agent, parameter ini diperlukan dalam skenario lain.
 RestoreTaskName:
  Type: String
  Description: Nama tugas pemulihan.
 BackupPlanId:
  Type: String
  Description: ID rencana cadangan.
 BackupGatewayId:
  Type: Number
  Description: >-
   ID gateway cadangan.

   Catatan DestinationEndpointInstanceType jika Anda menetapkan parameter ini ke agent,
   parameter ini diperlukan.
 DestinationEndpointInstanceID:
  Type: String
  Description: >-
   ID instance ApsaraDB RDS untuk kueri.

   Catatan DestinationEndpointInstanceType jika nilainya adalah RDS, ECS, DDS, atau
   Express, parameter ini diperlukan.
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 tugas pemulihan.
  Value:
   'Fn::GetAtt':
    - RestoreTask
    - RestoreTaskId