すべてのプロダクト
Search

このプロダクト

    Data Management:CreateRestoreTask

    ドキュメントセンター

    Data Management:CreateRestoreTask

    最終更新日:Apr 24, 2026

    この操作は、DBS の復元タスクを作成するために使用されます。

    操作説明

    関連操作

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:CreateRestoreTask

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアッププランの ID。

    dbs1hvb0ww****
    DestinationEndpointInstanceType

    string

    必須

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

    • RDS：ApsaraDB RDS インスタンス。

    • ECS：ECS インスタンスでホストされている自己管理データベース。

    • Express：専用回線、VPN Gateway、または Smart Access Gateway を介して接続されたデータベース。

    • Agent：バックアップゲートウェイを介して接続されたデータベース。

    • DDS：ApsaraDB for MongoDB (DDS) インスタンス。

    • Other：パブリック IP アドレスとポートを使用してインターネット経由で接続されたデータベース。

    • dg：パブリックエンドポイントを持たず、データベースゲートウェイ経由で接続された自己管理データベース。

    RDS
    DestinationEndpointRegion

    string

    任意

    宛先データベースインスタンスのリージョン ID。

    説明

    このパラメーターは、DestinationEndpointInstanceType が RDS、ECS、DDS、Express、または Agent に設定されている場合に必要です。

    cn-hangzhou
    DestinationEndpointInstanceID

    string

    任意

    宛先データベースインスタンスの ID。

    説明

    このパラメーターは、DestinationEndpointInstanceType が RDS、ECS、DDS、または Express に設定されている場合に必要です。

    rm-bp1p8c29*****
    DestinationEndpointIP

    string

    任意

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

    説明

    このパラメーターは、DestinationEndpointInstanceType が Express、Agent、または Other に設定されている場合に必要です。

    rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com
    DestinationEndpointPort

    integer

    任意

    宛先データベースへの接続に使用されるポート。

    説明

    このパラメーターは、DestinationEndpointInstanceType が Express、Agent、Other、または ECS に設定されている場合に必要です。

    3306
    DestinationEndpointDatabaseName

    string

    任意

    宛先データベースの名前。

    説明

    このパラメーターは、データベースエンジンが PostgreSQL または MongoDB の場合に必要です。

    test
    DestinationEndpointUserName

    string

    任意

    宛先データベースアカウントのユーザー名。

    説明

    このパラメーターは、データベースエンジンが Redis の場合、または DestinationEndpointInstanceType が Agent に設定され、データベースエンジンが MSSQL の場合はオプションです。その他のシナリオでは、このパラメーターは必須です。

    test
    DestinationEndpointPassword

    string

    任意

    宛先データベースアカウントのパスワード。

    説明

    このパラメーターは、データベースエンジンが Redis の場合、または DestinationEndpointInstanceType が Agent に設定され、データベースエンジンが MSSQL の場合はオプションです。その他のシナリオでは、このパラメーターは必須です。

    Test
    BackupGatewayId

    integer

    任意

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

    説明

    このパラメーターは、DestinationEndpointInstanceType が Agent に設定されている場合に必要です。

    4312****
    RestoreObjects

    string

    任意

    復元するオブジェクト。

    • このパラメーターは、DestinationEndpointInstanceType が Agent に設定されている場合はオプションです。その他のシナリオでは、このパラメーターは必須です。

    • 値は、[{ "DBName": "source_database_name", "NewDBName": "destination_database_name" }] のフォーマットの JSON 文字列である必要があります。

    説明

    この API オペレーションは、データベースレベルでのみデータを復元できます。テーブルレベルでデータを復元するには、コンソールにログインしてください。詳細については、「データベースの回復」をご参照ください。

    MySQL表级别恢复示例如下： [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
    RestoreTime

    integer

    任意

    復元のポイントインタイム。ミリ秒単位の UNIX タイムスタンプとして指定します。

    1554560477000
    BackupSetId

    string

    任意

    復元に使用する完全バックアップセットの ID。BackupSetId と RestoreTime パラメーターは相互排他です。

    dbs1hvb0w*****
    RestoreTaskName

    string

    必須

    復元ジョブの名前。

    test
    DestinationEndpointOracleSID

    string

    任意

    Oracle データベースの SID。

    説明

    このパラメーターは、データベースエンジンが Oracle の場合に必要です。

    test
    RestoreDir

    string

    任意

    復元ディレクトリ。このパラメーターは、DestinationEndpointInstanceType が Agent に設定され、データベースタイプが MySQL の場合に必要です。

    test
    RestoreHome

    string

    任意

    データベースのインストールディレクトリ。

    test
    DuplicateConflict

    string

    任意

    同名オブジェクトの競合を解決するためのポリシー。有効な値：

    renamenew：復元されたオブジェクトの名前が既存のオブジェクトと競合する場合、そのオブジェクトの名前を変更します。

    renamenew
    CrossAliyunId

    string

    任意

    ソースデータベースを所有する Alibaba Cloud アカウントの ID。このパラメーターは、クロスアカウント復元に必要です。

    2749528728********
    CrossRoleName

    string

    任意

    クロスアカウント復元に使用される RAM ロールの名前。

    test123
    ClientToken

    string

    任意

    リクエストのべき等性を保証するためのクライアント生成トークン。このトークンは、リクエスト間で一意である必要があります。

    ETnLKlblzczshOTUbOC********
    RestoreDestinationMode

    string

    任意

    復元先のタイプ。有効な値：

    • EXIST_INSTANCE：既存のインスタンスにデータを復元します。

    • NEW_INSTANCE：新規インスタンスにデータを復元します。

    EXIST_INSTANCE
    EnableDestinationEndpointSsl

    boolean

    任意

    宛先データベースへの接続に SSL 暗号化を有効にするかどうかを指定します。

    true
    SslCaPem

    string

    任意

    宛先データベースへの接続に使用される SSL 証明書。

    説明 このパラメーターは、EnableDestinationEndpointSsl が true に設定されている場合に必要です。

    -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
    DestDatabaseInstanceType

    string

    任意

    復元用に作成する新規インスタンスのタイプ。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    rds
    DestDatabaseInstanceRegion

    string

    任意

    新規インスタンスが作成されるリージョン。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    cn-beijing
    DestDatabaseInstanceVpc

    string

    任意

    新規インスタンスの VPC ID。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    vpc-xx
    DestDatabaseInstanceClass

    string

    任意

    新規インスタンスのインスタンスタイプ。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    mysql.x4.large.2
    DestDatabaseInstanceStorageSize

    string

    任意

    新規インスタンスのストレージ容量。単位：GB。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    500
    DestDatabaseInstanceVSwitch

    string

    任意

    新規インスタンスの vSwitch ID。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    vsw-xx
    DestDatabaseInstanceDatabaseVersion

    string

    任意

    新規インスタンスのデータベースエンジンバージョン。

    説明 このパラメーターは、RestoreDestinationMode が NEW_INSTANCE に設定されている場合に必要です。

    8.0
    AutoOpenDatabase

    string

    任意

    物理バックアップの復元後に Oracle インスタンスを自動的に開始するかどうかを指定します。有効な値：true および false。

    true
    AutoShutdownDatabase

    string

    任意

    物理バックアップを復元する前に Oracle インスタンスを自動的に停止するかどうかを指定します。有効な値：true および false。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    HttpStatusCode

    integer

    リクエストに対して返された HTTP ステータスコード。

    200
    RequestId

    string

    リクエストの ID。

    60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
    ErrCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    Param.NotFound
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    The specified parameter %s value is not valid.

    RestoreTaskId

    string

    復元タスクの ID。

    s102h*****

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "RestoreTaskId": "s102h*****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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