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 操作を呼び出すことができます。ROS を使用してオーケストレーションできるリソースには、通常のリソースとデータリソースがあります。

通常のリソース：
- 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は、ROS コンソールにログインするユーザーの認証情報を使用します。ユーザーには、次の権限が付与されている必要があります。

AliyunHBRFullAccess：Cloud Backup に対する完全な権限を付与します。

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

操作手順

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

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

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

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultName:
    Description: バックアップボールトの名前。名前の長さは 1〜64 文字である必要があります。
    MaxLength: 64
    MinLength: 1
    Type: String
    Default: test-valut
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-valut"
    }
  },
  "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"
        ]
      }
    }
  }
}

[作成] をクリックし、作成したスタックを実行します。
結果を表示します。
test-valut という名前のバックアップボールトが作成された後、API の呼び出し、SDK の実行、または Cloud Backup コンソールでの操作によって、バックアップボールトを表示できます。