すべてのプロダクト
Search

このプロダクト

    :CreateRestoreTask

    ドキュメントセンター

    :CreateRestoreTask

    最終更新日:Dec 01, 2025

    Database Backup Service (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 Access Gateway 経由で接続されたデータベース。

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

    • DDS：クラウド MongoDB インスタンス。

    • Other：インターネット経由で接続されたデータベース。

    • dg：パブリック IP アドレスとポートを持たない自己管理データベース。このタイプのデータベースは、Database Gateway (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 の場合、または 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" }]

    説明

    この API 操作を使用する場合、データベースレベルでのみオブジェクトを復元できます。特定のテーブルを復元するには、コンソールを使用してください。詳細については、「データベースの復元」をご参照ください。

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

    integer

    任意

    復元時間。ミリ秒単位の UNIX タイムスタンプで指定します。

    1554560477000
    BackupSetId

    string

    任意

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

    dbs1hvb0w*****
    RestoreTaskName

    string

    必須

    復元ジョブの名前。

    test
    DestinationEndpointOracleSID

    string

    任意

    Oracle システム ID (SID)。

    説明

    データベースタイプが Oracle の場合、このパラメーターは必須です。

    test
    RestoreDir

    string

    任意

    このパラメーターは、DestinationEndpointInstanceType が agent に設定され、バックアッププランが MySQL データベース用である場合に必須です。

    test
    RestoreHome

    string

    任意

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

    test
    DuplicateConflict

    string

    任意

    同じ名前のオブジェクトとの競合を処理するためのポリシー。次の値がサポートされています：

    renamenew：同じ名前のオブジェクトが存在する場合、新しいオブジェクトの名前を変更します。

    renamenew
    CrossAliyunId

    string

    任意

    クロスアカウントバックアップ用の Alibaba Cloud アカウントの UID。

    2749528728********
    CrossRoleName

    string

    任意

    クロスアカウントバックアップ用の RAM ロールの名前。

    test123
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。これにより、重複した送信を防ぎます。

    ETnLKlblzczshOTUbOC********

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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

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

    変更履歴

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