すべてのプロダクト
Search

このプロダクト

    :CreateRestoreTask

    ドキュメントセンター

    :CreateRestoreTask

    最終更新日:Mar 20, 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

    • ECS

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

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

    • DDS：Cloud MongoDB。

    • Other：IP:Port を介して直接接続されたデータベース。

    • dg：パブリック IP:Port を持たない自己管理型データベース (データベースゲートウェイ DG を介して接続)。

    RDS
    DestinationEndpointRegion

    string

    任意

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

    説明

    このパラメーターは、`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 の場合、またはデータベースの場所が agent でデータベースタイプが MSSQL の場合はオプションです。その他のシナリオでは必須です。

    test
    DestinationEndpointPassword

    string

    任意

    パスワード。

    説明

    このパラメーターは、データベースタイプが Redis の場合、またはデータベースの場所が agent でデータベースタイプが MSSQL の場合はオプションです。その他のシナリオでは必須です。

    Test
    BackupGatewayId

    integer

    任意

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

    説明

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

    4312****
    RestoreObjects

    string

    任意

    復元オブジェクト。

    • 詳細については、以下の `RestoreObjects` パラメーターの定義をご参照ください。このパラメーターは、データベースの場所が agent の場合はオプションです。その他のシナリオでは必須です。

    • テンプレート： [{ "DBName": "復元するデータベースの名前", "NewDBName": "復元先のターゲットデータベースの名前" }]

    説明

    この API は、データベースレベルでのオブジェクトの復元のみをサポートします。テーブルレベルの回復を設定するには、コンソールに移動してください。詳細については、「データベースの回復」をご参照ください。

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

    integer

    任意

    復元時間。例：1554560477000。

    1554560477000
    BackupSetId

    string

    任意

    回復に使用される完全バックアップセットの ID。このパラメーターは `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 アカウント間のバックアップ用の UID。

    2749528728********
    CrossRoleName

    string

    任意

    Alibaba Cloud アカウント間のバックアップ用の RAM ロール名。

    test123
    ClientToken

    string

    任意

    リクエストのべき等性を保証し、重複した送信を防ぐために使用されます。

    ETnLKlblzczshOTUbOC********
    RestoreDestinationMode

    string

    任意

    exist_instance
    EnableDestinationEndpointSsl

    boolean

    任意

    SslCaPem

    string

    任意

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

    string

    任意

    rds
    DestDatabaseInstanceRegion

    string

    任意

    cn-beijing
    DestDatabaseInstanceVpc

    string

    任意

    vpc-xx
    DestDatabaseInstanceClass

    string

    任意

    mysql.x4.large.2
    DestDatabaseInstanceStorageSize

    string

    任意

    500
    DestDatabaseInstanceVSwitch

    string

    任意

    DestDatabaseInstanceDatabaseVersion

    string

    任意

    AutoOpenDatabase

    string

    任意

    AutoShutdownDatabase

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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

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

    変更履歴

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