すべてのプロダクト
Search

このプロダクト

    :CreateBackupPlan

    ドキュメントセンター

    :CreateBackupPlan

    最終更新日:Mar 27, 2026

    バックアッププランを作成します。

    操作説明

    重要

    • この API を呼び出して、ECS ファイルバックアップの基本版、クラウドディスクバックアップ、コンテナバックアップ、TableStore バックアップの無料トライアル、アーカイブ、データ同期などの機能を使用します。

    • NAS バックアップまたは OSS バックアップの 30 日間無料トライアルを使用するには、CreateTrialBackupPlan 操作を呼び出します。

    • ECS ファイルバックアップ、ローカルファイルバックアップ、ECS インスタンスのバックアップ機能、NAS バックアップ、OSS バックアップ、または CPFS バックアップの標準機能を使用するには、CreatePolicyV2 および CreatePolicyBindings 操作を呼び出します。

    • バックアッププランを実行すると、その進捗と結果を記録するバックアップジョブが作成されます。成功したジョブはバックアップスナップショットを生成し、それを使用して復元ジョブを作成できます。

    • バックアッププランは 1 つのデータソースのみをサポートします。

    • バックアッププランは、固定間隔サイクルを持つ 1 つのバックアップポリシーのみをサポートします。

    • バックアッププランは、1 つのバックアップリポジトリにのみバックアップできます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:CreateBackupPlan

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SourceType

    string

    必須

    データソースのタイプ。有効な値:

    • ECS_FILE: ECS インスタンスからファイルをバックアップします。

    • OSS: OSS バケットをバックアップします。

    • NAS: NAS ファイルシステムをバックアップします。

    • OTS: Tablestore インスタンスをバックアップします。

    • UDM_ECS: ECS インスタンス全体をバックアップします。

    • SYNC: データ同期を実行します。

    ECS_FILE
    PlanName

    string

    任意

    バックアッププランの名前。名前は 1～64 文字の長さである必要があります。名前は、バックアップリポジトリ内のデータソースタイプごとに一意である必要があります。

    planname
    BackupType

    string

    任意

    バックアップタイプ。値を COMPLETE に設定します。これは完全バックアップを指定します。

    COMPLETE
    VaultId

    string

    任意

    バックアップリポジトリの ID。

    v-0006******q
    Schedule

    string

    任意

    バックアップポリシー。フォーマットは I|{startTime}|{interval} です。これは、{startTime} から開始し、{interval} の間隔でバックアップジョブが実行されることを指定します。期限切れのバックアップジョブは再試行されません。前のバックアップジョブが完了していない場合、次のバックアップジョブはトリガーされません。例えば、I|1631685600|P1D は、2021 年 9 月 15 日 14:00:00 から毎日バックアップジョブが実行されることを示します。

    • startTime: バックアップの開始時刻。UNIX タイムスタンプ (秒単位) で指定します。

    • interval: バックアップ間隔。ISO 8601 期間フォーマットで指定します。例えば、PT1H は 1 時間、P1D は 1 日を表します。

    I|1602673264|P1D
    Retention

    integer

    任意

    バックアップの保存期間 (日数)。最小値は 1 です。

    7
    ClusterId

    string

    任意

    データ同期ジョブを実行するクライアントグループの ID。このパラメーターは、SourceType が SYNC に設定されている場合にのみ必須です。

    cl-***************
    FileSystemId

    string

    任意

    ファイルシステムの ID。このパラメーターは、SourceType が NAS に設定されている場合にのみ必須です。

    005494
    CreateTime

    integer

    任意

    ファイルシステムが作成された時刻。UNIX タイムスタンプ (秒単位) で指定します。このパラメーターは、SourceType が NAS に設定されている場合にのみ必須です。

    1607436917
    Bucket

    string

    任意

    OSS バケットの名前。このパラメーターは、SourceType が OSS に設定されている場合にのみ必須です。

    hbr-backup-oss
    Prefix

    string

    任意

    バックアップするオブジェクトのプレフィックス。指定した場合、このプレフィックスを持つオブジェクトのみがバックアップされます。このパラメーターは、SourceType が OSS に設定されている場合にのみ必須です。

    oss-prefix
    InstanceId

    string

    任意

    ECS インスタンスの ID。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必須です。

    i-m5e*****6q
    Detail

    object

    任意

    インスタンス全体のバックアップの詳細。JSON 文字列として指定します。

    • snapshotGroup: スナップショット整合性グループを使用するかどうかを指定します。この機能は、インスタンスのすべてのディスクが ESSD である場合にのみ利用可能です。

    • appConsistent: アプリケーション整合性を有効にするかどうかを指定します。これは preScriptPath および postScriptPath パラメーターと組み合わせて使用する必要があります。

    • preScriptPath: フリーズ前スクリプトへのパス。

    • postScriptPath: 解凍後スクリプトへのパス。

    {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
    UdmRegionId

    string

    任意

    ECS インスタンスが配置されているリージョン。

    cn-shanghai
    SpeedLimit

    string

    任意

    バックアップのトラフィックシェーピングポリシー。フォーマット: {start}:{end}:{bandwidth}。縦棒 (|) で区切られた複数のルールを指定できます。指定された時間範囲は重複できません。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必須です。

    • start: 開始時刻 (時)。

    • end: 終了時刻 (時)。

    • bandwidth: 帯域幅制限 (KB/秒)。

    0:24:5120
    Include

    string

    任意

    バックアップに含めるファイルとディレクトリのパス。パスは最大 255 文字の長さです。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必須です。

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Exclude

    string

    任意

    バックアップから除外するファイルとディレクトリのパス。パスは最大 255 文字の長さです。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必須です。

    ["/var", "/proc"]
    Options

    string

    任意

    データ整合性を確保するために Windows ボリューム シャドウ コピー サービス (VSS) を使用するかどうかを指定します。このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必須です。

    • この機能は Windows ECS インスタンスでのみ利用可能です。

    • バックアップ中にバックアップソースのデータが変更された場合、データ整合性を確保するには、このパラメーターを {"UseVSS":true} に設定します。

    • VSS を有効にすると、複数のファイルディレクトリを同時にバックアップすることはできません。

    {"UseVSS":false}
    DataSourceId

    string

    任意

    ソースデータソースの ID。このパラメーターは、SourceType が SYNC に設定されている場合にのみ必須です。

    ds-****************
    Path

    array

    任意

    バックアップパス。

    string

    任意

    バックアップパス。パスは最大 65,536 文字の長さです。 バックアップパスには以下のルールが適用されます。

    • ワイルドカード (*) を使用しない場合、最大 20 個のパスを指定できます。

    • ワイルドカード (*) を使用する場合、1 つのパスのみを指定できます。/*/* のようなワイルドカードパターンがサポートされています。

    • 各パスは絶対パスである必要があります。

    • VSS が有効な場合、複数のパス、UNC パス、ワイルドカード、またはファイル除外を使用することはできません。

    • UNC パスが使用されている場合、VSS、ワイルドカード、およびファイル除外はサポートされません。バックアップソースに UNC パスが含まれている場合、Windows ACL はバックアップされません。

    ["/home"]
    Rule

    array<object>

    任意

    バックアップルール。

    object

    任意

    バックアップルール。

    DestinationRetention

    integer

    任意

    地理的冗長バックアップの保存期間 (日数)。

    7
    Schedule

    string

    任意

    バックアップポリシー。フォーマットは I|{startTime}|{interval} です。これは、{startTime} から開始し、{interval} の間隔でバックアップジョブが実行されることを指定します。期限切れのバックアップジョブは再試行されません。前のバックアップジョブが完了していない場合、次のバックアップジョブはトリガーされません。例えば、I|1631685600|P1D は、2021 年 9 月 15 日 14:00:00 から毎日バックアップジョブが実行されることを示します。

    フォーマットでは、startTime はバックアップ開始時刻 (UNIX タイムスタンプ (秒単位))、interval はバックアップ間隔 (ISO 8601 期間フォーマット) です。例えば、PT1H は 1 時間、P1D は 1 日を表します。

    I|1602673264|P1D
    Retention

    integer

    任意

    バックアップの保存期間 (日数)。

    7
    Disabled

    boolean

    任意

    ルールを無効にするかどうかを指定します。

    false
    DoCopy

    boolean

    任意

    バックアップの地理的冗長性を有効にするかどうかを指定します。

    false
    DestinationRegionId

    string

    任意

    地理的冗長性の送信先リージョン ID。

    cn-hangzhou
    RuleName

    string

    任意

    ルールの名前。

    rule-test-name
    BackupType

    string

    任意

    バックアップタイプ。

    COMPLETE
    InstanceName

    string

    任意

    Tablestore インスタンスの名前。

    instancename
    OtsDetail OtsDetail

    任意

    Tablestore インスタンスの詳細。

    CrossAccountType

    string

    任意

    クロスアカウントバックアップのタイプ。有効な値:

    • SELF_ACCOUNT: 同じアカウント内でデータをバックアップします。

    • CROSS_ACCOUNT: 別のアカウントにデータをバックアップします。

    列挙値:

    • SELF_ACCOUNT :

      SELF_ACCOUNT

    • CROSS_ACCOUNT :

      CROSS_ACCOUNT

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    任意

    クロスアカウントバックアップのソース Alibaba Cloud アカウントの ID。

    15897534xxxx4625
    CrossAccountRoleName

    string

    任意

    ソースアカウントで作成される RAM ロールの名前。

    BackupRole
    KeepLatestSnapshots

    integer

    任意

    最新のバックアップスナップショットを永続的に保持するかどうかを指定します。

    • 0: 保持しない。

    • 1: 保持する。

    列挙値:

    • 0 :

      No

    • 1 :

      Yes

    1
    DestSourceType

    string

    任意

    送信先データソースのタイプ。このパラメーターは、SourceType が SYNC に設定されている場合にのみ必須です。

    OSS
    DestDataSourceId

    string

    任意

    送信先データソースの ID。このパラメーターは、SourceType が SYNC に設定されている場合にのみ必須です。

    ds-*********************

    DestDataSourceDetail

    object

    任意

    送信先データソースの詳細。このパラメーターは、SourceType が SYNC に設定されている場合にのみ必須です。

    {\"prefix\":\"/\"}
    ChangeListPath

    string

    任意

    増分ファイル同期の変更リスト構成。このパラメーターは、SourceType が SYNC に設定されている場合にのみ必須です。

    {"dataSourceId": "ds-123456789", "path": "/changelist"}
    Disabled

    boolean

    任意

    作成時にバックアッププランを無効にするかどうかを指定します。

    true
    Edition

    string

    任意

    バックアッププランのエディション。有効な値は BASIC と STANDARD です。デフォルト値: STANDARD。

    STANDARD

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    Code

    string

    応答コード。値 200 は、リクエストが成功したことを示します。

    200
    Message

    string

    応答メッセージ。リクエストが成功した場合、値は successful です。リクエストが失敗した場合、エラーメッセージが返されます。

    successful
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PlanId

    string

    バックアッププラン ID。

    plan-*********************
    Success

    boolean

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

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PlanId": "plan-*********************",
  "Success": true
}

    エラーコード

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

    変更履歴

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