Resource Orchestration Service (ROS) を使用した Cloud Backup バックアップボールトの作成 - Cloud Backup

Resource Orchestration Service (ROS) を使用して Cloud Backup のリソースを呼び出すことができます。Resource Orchestration Service テンプレートを作成して、Cloud Backup のバックアップボールトを自動的に作成します。

サポートされているリソース

ROS は、クラウドリソース管理を簡素化する Alibaba Cloud のサービスです。Elastic Compute Service (ECS) インスタンス、Object Storage Service (OSS) バケット、File Storage NAS (NAS) ファイルシステムなどの必要なリソースと、それらの間の依存関係を記述したテンプレートを作成します。その後、ROS はテンプレートに基づいてすべてのリソースを自動的に作成、設定します。詳細については、「Resource Orchestration Service とは」をご参照ください。

ROS は Cloud Backup API をオーケストレーションできます。サポートされているリソースには、通常のリソースとデータリソースが含まれます。

通常のリソース：
- ALIYUN::HBR::BackupClients：ECS インスタンスにバックアップクライアントをインストールします。
- ALIYUN::HBR::RestoreJob：復元ジョブを作成します。
- ALIYUN::HBR::DbAgent：データベースのバックアップクライアントをインストールします。
- ALIYUN::HBR::DbPlan：バックアッププランを作成します。
- ALIYUN::HBR::DbVault：ミラーボールトを作成します。
- ALIYUN::HBR::Vault：バックアップボールトを作成します。
データリソース：
- DATASOURCE::HBR::Vaults：バックアップボールトに関する情報を照会します。

権限

この例でバックアップボールトを作成するために、Resource Orchestration Service はデフォルトで現在のコンソールユーザーの認証情報を使用します。ユーザーには次の権限が必要です：

AliyunHBRFullAccess：Cloud Backup に対する完全な権限を付与するポリシーです。

Alibaba Cloud アカウントはすべての API に対する権限を持っているため、セキュリティリスクが生じる可能性があります。API コールと日常的な O&M には、RAM ユーザーを使用することを推奨します。ビジネス要件に基づいて Cloud Backup リソースを管理するために必要な権限を RAM ユーザーに付与してください。詳細については、「Cloud Backup 操作を実行するための RAM ユーザーの作成」をご参照ください。

操作手順

ROS コンソールにログインします。上部メニューで、[Region] ドロップダウンリストからリージョンを選択します。
左側のナビゲーションウィンドウで、[スタック] をクリックします。[スタックの作成] > ROSの使用 を選択します。
- テンプレートの指定：既存テンプレートの使用 を選択します。
- テンプレートのインポート方法：テンプレート内容の入力 を選択します。

[テンプレートの内容] で、Ros を選択し、コードを入力します。

バックアップボールトを作成するための構文、説明、および使用例の詳細については、「ALIYUN::HBR::Vault」をご参照ください。この例では、test-vault という名前のバックアップボールトを作成します。

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultName:
    Description: バックアップボールトの名前。名前は 1～64 文字にする必要があります。
    MaxLength: 64
    MinLength: 1
    Type: String
    Default: test-vault
Resources:
  ExtensionResource:
    Properties:
      VaultName:
        Ref: VaultName
      VaultType: STANDARD
    Type: ALIYUN::HBR::Vault
Outputs:
  BackupPlanStatistics:
    Description: バックアップボールトを使用するバックアッププランの統計。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - BackupPlanStatistics
  BytesDone:
    Description: 'バックアップされたデータ量。単位：バイト。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - BytesDone
  CreateTime:
    Description: 'バックアップボールトが作成された時刻。この値は UNIX タイムスタンプです。単位：秒。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - CreateTime
  Dedup:
    Description: 重複排除機能が有効になっているかどうかを示します。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Dedup
  Description:
    Description: バックアップボールトの説明。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Description
  IndexAvailable:
    Description: インデックスが利用可能かどうかを示します。インデックスは更新中でない場合に利用可能です。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexAvailable
  IndexLevel:
    Description: 'インデックスレベル。

      - **OFF**: インデックスは作成されません。

      - **META**: メタデータインデックスが作成されます。

      - **ALL**: 全文インデックスが作成されます。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexLevel
  IndexUpdateTime:
    Description: インデックスが更新された時刻。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexUpdateTime
  LatestReplicationTime:
    Description: '最後のリモートバックアップが同期された時刻。この値は UNIX タイムスタンプです。単位：秒。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - LatestReplicationTime
  PaymentType:
    Description: 支払いタイプ。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - PaymentType
  RedundancyType:
    Description: 'バックアップボールトのデータ冗長タイプ。有効な値：

      - **LRS**: バックアップボールトに対してローカル冗長ストレージ (LRS) が有効になっています。HBR は、同じゾーン内の異なる施設の複数のデバイスに各オブジェクトのコピーを保存します。これにより、ハードウェア障害が発生した場合でも、HBR はデータの耐久性と可用性を確保します。

      - **ZRS**: バックアップボールトに対してゾーン冗長ストレージ (ZRS) が有効になっています。HBR は、マルチゾーンメカニズムを使用して、同じリージョン内の 3 つのゾーンにデータを分散します。ゾーンに障害が発生した場合でも、他の 2 つのゾーンに保存されているデータにアクセスできます。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - RedundancyType
  Replication:
    Description: 'バックアップボールトがリモートバックアップボールトであるかどうかを示します。有効な値：

      - **true**: バックアップボールトはリモートバックアップボールトです。

      - **false**: バックアップボールトはオンプレミスのバックアップボールトです。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Replication
  ReplicationProgress:
    Description: バックアップボールトからミラーボールトへのデータ同期の進捗。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationProgress
  ReplicationSourceRegionId:
    Description: リモートバックアップボールトが存在するリージョンの ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationSourceRegionId
  ReplicationSourceVaultId:
    Description: リモートバックアップボールトに対応するソースボールトの ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationSourceVaultId
  ResourceGroupId:
    Description: リソースグループの ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ResourceGroupId
  Retention:
    Description: 'バックアップボールトの保存期間。単位：日。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Retention
  SearchEnabled:
    Description: バックアップ検索機能が有効になっているかどうかを示します。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - SearchEnabled
  SourceTypes:
    Description: データソースに関する情報。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - SourceTypes
  StorageSize:
    Description: 'バックアップボールトの使用量。単位：バイト。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - StorageSize
  Tags:
    Description: バックアップボールトのタグ。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Tags
  TrialInfo:
    Description: 無料トライアル情報。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - TrialInfo
  UpdatedTime:
    Description: 'バックアップボールトが更新された時刻。この値は UNIX タイムスタンプです。単位：秒。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - UpdatedTime
  VaultId:
    Description: バックアップボールトの ID。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultId
  VaultName:
    Description: バックアップボールトの名前。
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultName
  VaultStatusMessage:
    Description: 'バックアップボールトが ERROR 状態の場合に返されるステータスメッセージ。このパラメーターは、リモートバックアップボールトでのみ使用できます。有効な値：

      - UNKNOWN_ERROR: 不明なエラーが発生しました。

      - SOURCE_VAULT_ALREADY_HAS_REPLICATION: ソースボールトにミラーボールトがすでに設定されています。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultStatusMessage
  VaultStorageClass:
    Description: 'バックアップボールトのストレージタイプ。有効な値：**STANDARD**。標準ストレージを示します。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultStorageClass
  VaultType:
    Description: 'バックアップボールトのタイプ。有効な値：**STANDARD**。標準バックアップボールトを示します。'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultType

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VaultName": {
      "Description": "バックアップボールトの名前。名前は 1～64 文字にする必要があります。",
      "MaxLength": 64,
      "MinLength": 1,
      "Type": "String",
      "Default": "test-vault"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Properties": {
        "VaultName": {
          "Ref": "VaultName"
        },
        "VaultType": "STANDARD"
      },
      "Type": "ALIYUN::HBR::Vault"
    }
  },
  "Outputs": {
    "BackupPlanStatistics": {
      "Description": "バックアップボールトを使用するバックアッププランの統計。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BackupPlanStatistics"
        ]
      }
    },
    "BytesDone": {
      "Description": "バックアップされたデータ量。単位：バイト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BytesDone"
        ]
      }
    },
    "CreateTime": {
      "Description": "バックアップボールトが作成された時刻。この値は UNIX タイムスタンプです。単位：秒。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "Dedup": {
      "Description": "重複排除機能が有効になっているかどうかを示します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Dedup"
        ]
      }
    },
    "Description": {
      "Description": "バックアップボールトの説明。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "IndexAvailable": {
      "Description": "インデックスが利用可能かどうかを示します。インデックスは更新中でない場合に利用可能です。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexAvailable"
        ]
      }
    },
    "IndexLevel": {
      "Description": "インデックスレベル。\n- **OFF**: インデックスは作成されません。\n- **META**: メタデータインデックスが作成されます。\n- **ALL**: 全文インデックスが作成されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexLevel"
        ]
      }
    },
    "IndexUpdateTime": {
      "Description": "インデックスが更新された時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexUpdateTime"
        ]
      }
    },
    "LatestReplicationTime": {
      "Description": "最後のリモートバックアップが同期された時刻。この値は UNIX タイムスタンプです。単位：秒。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "LatestReplicationTime"
        ]
      }
    },
    "PaymentType": {
      "Description": "支払いタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PaymentType"
        ]
      }
    },
    "RedundancyType": {
      "Description": "バックアップボールトのデータ冗長タイプ。有効な値：\n- **LRS**: バックアップボールトに対してローカル冗長ストレージ (LRS) が有効になっています。HBR は、同じゾーン内の異なる施設の複数のデバイスに各オブジェクトのコピーを保存します。これにより、ハードウェア障害が発生した場合でも、HBR はデータの耐久性と可用性を確保します。\n- **ZRS**: バックアップボールトに対してゾーン冗長ストレージ (ZRS) が有効になっています。HBR は、マルチゾーンメカニズムを使用して、同じリージョン内の 3 つのゾーンにデータを分散します。ゾーンに障害が発生した場合でも、他の 2 つのゾーンに保存されているデータにアクセスできます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RedundancyType"
        ]
      }
    },
    "Replication": {
      "Description": "バックアップボールトがリモートバックアップボールトであるかどうかを示します。有効な値：\n- **true**: バックアップボールトはリモートバックアップボールトです。\n- **false**: バックアップボールトはオンプレミスのバックアップボールトです。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Replication"
        ]
      }
    },
    "ReplicationProgress": {
      "Description": "バックアップボールトからミラーボールトへのデータ同期の進捗。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationProgress"
        ]
      }
    },
    "ReplicationSourceRegionId": {
      "Description": "リモートバックアップボールトが存在するリージョンの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationSourceRegionId"
        ]
      }
    },
    "ReplicationSourceVaultId": {
      "Description": "リモートバックアップボールトに対応するソースボールトの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationSourceVaultId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "Retention": {
      "Description": "バックアップボールトの保存期間。単位：日。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Retention"
        ]
      }
    },
    "SearchEnabled": {
      "Description": "バックアップ検索機能が有効になっているかどうかを示します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SearchEnabled"
        ]
      }
    },
    "SourceTypes": {
      "Description": "データソースに関する情報。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourceTypes"
        ]
      }
    },
    "StorageSize": {
      "Description": "バックアップボールトの使用量。単位：バイト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "StorageSize"
        ]
      }
    },
    "Tags": {
      "Description": "バックアップボールトのタグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "TrialInfo": {
      "Description": "無料トライアル情報。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TrialInfo"
        ]
      }
    },
    "UpdatedTime": {
      "Description": "バックアップボールトが更新された時刻。この値は UNIX タイムスタンプです。単位：秒。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedTime"
        ]
      }
    },
    "VaultId": {
      "Description": "バックアップボールトの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultId"
        ]
      }
    },
    "VaultName": {
      "Description": "バックアップボールトの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultName"
        ]
      }
    },
    "VaultStatusMessage": {
      "Description": "バックアップボールトが ERROR 状態の場合に返されるステータスメッセージ。このパラメーターは、リモートバックアップボールトでのみ使用できます。有効な値：\n- UNKNOWN_ERROR: 不明なエラーが発生しました。\n- SOURCE_VAULT_ALREADY_HAS_REPLICATION: ソースボールトにミラーボールトがすでに設定されています。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultStatusMessage"
        ]
      }
    },
    "VaultStorageClass": {
      "Description": "バックアップボールトのストレージタイプ。有効な値：**STANDARD**。標準ストレージを示します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultStorageClass"
        ]
      }
    },
    "VaultType": {
      "Description": "バックアップボールトのタイプ。有効な値：**STANDARD**。標準バックアップボールトを示します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultType"
        ]
      }
    }
  }
}

[作成] をクリックし、作成されたスタックを実行します。
結果を確認します。

ROS コンソールのスタック詳細ページで、[スタック情報] タブの [ステータス] に [CREATE_COMPLETE] と表示されます。
test-vault という名前のバックアップボールトが作成された後、API の呼び出し、SDK の実行、または Cloud Backup コンソールでの操作によってバックアップボールトを表示できます。

テンプレートが実行された後、[ボールト管理] ページで、test-vault という名前のボールトが作成されていることを確認できます。ボールトタイプは [Standard] で、ステータスは [アクティブ化済み] です。