すべてのプロダクト
Search
ドキュメントセンター

Cloud Backup:ROSの操作

最終更新日:Jul 19, 2024

Resource Orchestration Service (ROS) を使用して、Cloud Backupリソースを呼び出すことができます。 このトピックでは、Resource Orchestration Serviceテンプレートを作成し、そのテンプレートを使用してCloud Backupのバックアップコンテナーを自動的に作成する方法について説明します。

サポートされるリソース

ROSは、クラウドコンピューティングリソースの管理を簡素化するAlibaba Cloudサービスです。 Elastic Compute Service (ECS) やApsaraDB RDSインスタンスなどの必要なクラウドコンピューティングリソース、およびリソース間の依存関係を記述するテンプレートを作成できます。 ROSは、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、自動デプロイとO&Mを実装します。詳細については、「」をご参照ください。ROSとは何ですか?

ROSを使用して、Cloud BackupのAPI操作を呼び出すことができます。 ROSを使用して調整できるリソースには、通常のリソースとデータリソースがあります。

権限

この例では、バックアップコンテナーを作成する必要があります。 デフォルトでは、Resource Orchestration ServiceはROSコンソールにログインしたユーザーの資格情報を使用します。 ユーザーには次の権限を付与する必要があります。

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

Alibaba Cloudアカウントには、すべてのAPI操作に対する権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーとしてAPI操作を呼び出すか、ルーチンのO&Mを実行することを推奨します。 RAMユーザーとしてAPI操作を呼び出す前に、ビジネス要件に基づいて必要な権限をRAMユーザーに付与します。 RAMユーザーには、Cloud Backupリソースを管理する権限が必要です。 詳細については、「RAMユーザーを作成し、RAMユーザーにクラウドバックアップへのアクセスを許可する」をご参照ください。

手順

  1. ROSコンソールにログインします。 上部のナビゲーションバーで、[リージョン] ドロップダウンリストからリージョンを選択します。

  2. 左側のナビゲーションペインで、[スタック] をクリックします。 [スタック] ページで、[スタックの作成] > [ROSを使用] を選択します。

    • テンプレートの指定: [既存のテンプレートの選択] を選択します。

    • テンプレートインポート方法: [テンプレートコンテンツの入力] を選択します。

  3. テンプレートの内容: [ROS] を選択し、コードを入力します。

    バックアップコンテナーの作成方法の構文、説明、および例の詳細については、「ALIYUN::HBR:: vault」をご参照ください。 この例では、test-vaultという名前のバックアップコンテナーを作成します。

    YAML形式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      VaultName:
        Description: The name of the backup vault. The name must be 1 to 64 characters
          in length.
        MaxLength: 64
        MinLength: 1
        Type: String
        Default: test-valut
    Resources:
      ExtensionResource:
        Properties:
          VaultName:
            Ref: VaultName
          VaultType: STANDARD
        Type: ALIYUN::HBR::Vault
    Outputs:
      BackupPlanStatistics:
        Description: The statistics of backup plans that use the backup vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - BackupPlanStatistics
      BytesDone:
        Description: 'The amount of data that is backed up. Unit: bytes.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - BytesDone
      CreateTime:
        Description: 'The time when the backup vault was created. This value is a UNIX
          timestamp. Unit: seconds.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - CreateTime
      Dedup:
        Description: Indicates whether the deduplication feature is enabled.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - Dedup
      Description:
        Description: The description of the backup vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - Description
      IndexAvailable:
        Description: Indicates whether indexes are available. Indexes are available when
          they are not being updated.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - IndexAvailable
      IndexLevel:
        Description: 'The index level.
    
          - **OFF**: No indexes are created.
    
          - **META**: Metadata indexes are created.
    
          - **ALL**: Full-text indexes are created.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - IndexLevel
      IndexUpdateTime:
        Description: The time when the index was updated.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - IndexUpdateTime
      LatestReplicationTime:
        Description: 'The time when the last remote backup was synchronized. This value
          is a UNIX timestamp. Unit: seconds.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - LatestReplicationTime
      PaymentType:
        Description: PaymentType.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - PaymentType
      RedundancyType:
        Description: 'The data redundancy type of the backup vault. Valid values:
    
          - **LRS**: Locally redundant storage (LRS) is enabled for the backup vault.
          HBR stores the copies of each object on multiple devices of different facilities
          in the same zone. This way, HBR ensures data durability and availability even
          if hardware failures occur.
    
          - **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR
          uses the multi-zone mechanism to distribute data across three zones within the
          same region. If a zone fails, the data that is stored in the other two zones
          is still accessible.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - RedundancyType
      Replication:
        Description: 'Indicates whether the backup vault is a remote backup vault. Valid
          values:
    
          - **true**: The backup vault is a remote backup vault.
    
          - **false**: The backup vault is an on-premises backup vault.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - Replication
      ReplicationProgress:
        Description: The progress of data synchronization from the backup vault to the
          mirror vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - ReplicationProgress
      ReplicationSourceRegionId:
        Description: The ID of the region where the remote backup vault resides.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - ReplicationSourceRegionId
      ReplicationSourceVaultId:
        Description: The ID of the source vault that corresponds to the remote backup
          vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - ReplicationSourceVaultId
      ResourceGroupId:
        Description: The ID of the resource group.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - ResourceGroupId
      Retention:
        Description: 'The retention period of the backup vault. Unit: days.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - Retention
      SearchEnabled:
        Description: Indicates whether the backup search feature is enabled.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - SearchEnabled
      SourceTypes:
        Description: The information about the data source.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - SourceTypes
      StorageSize:
        Description: 'The usage of the backup vault. Unit: bytes.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - StorageSize
      Tags:
        Description: The tags of the backup vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - Tags
      TrialInfo:
        Description: The free trial information.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - TrialInfo
      UpdatedTime:
        Description: 'The time when the backup vault was updated. This value is a UNIX
          timestamp. Unit: seconds.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - UpdatedTime
      VaultId:
        Description: The ID of the backup vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - VaultId
      VaultName:
        Description: The name of the backup vault.
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - VaultName
      VaultStatusMessage:
        Description: 'The status message that is returned when the backup vault is in
          the ERROR state. This parameter is available only for remote backup vaults.
          Valid values:
    
          - **UNKNOWN_ERROR*: An unknown error occurs.
    
          - **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for
          the source vault.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - VaultStatusMessage
      VaultStorageClass:
        Description: 'The storage type of the backup vault. Valid value: **STANDARD**,
          which indicates standard storage.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - VaultStorageClass
      VaultType:
        Description: 'The type of the backup vault. Valid value: **STANDARD**, which indicates
          a standard backup vault.'
        Value:
          Fn::GetAtt:
          - ExtensionResource
          - VaultType

    JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "VaultName": {
          "Description": "The name of the backup vault. The name must be 1 to 64 characters in length.",
          "MaxLength": 64,
          "MinLength": 1,
          "Type": "String",
          "Default": "test-valut"
        }
      },
      "Resources": {
        "ExtensionResource": {
          "Properties": {
            "VaultName": {
              "Ref": "VaultName"
            },
            "VaultType": "STANDARD"
          },
          "Type": "ALIYUN::HBR::Vault"
        }
      },
      "Outputs": {
        "BackupPlanStatistics": {
          "Description": "The statistics of backup plans that use the backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "BackupPlanStatistics"
            ]
          }
        },
        "BytesDone": {
          "Description": "The amount of data that is backed up. Unit: bytes.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "BytesDone"
            ]
          }
        },
        "CreateTime": {
          "Description": "The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "CreateTime"
            ]
          }
        },
        "Dedup": {
          "Description": "Indicates whether the deduplication feature is enabled.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Dedup"
            ]
          }
        },
        "Description": {
          "Description": "The description of the backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Description"
            ]
          }
        },
        "IndexAvailable": {
          "Description": "Indicates whether indexes are available. Indexes are available when they are not being updated.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "IndexAvailable"
            ]
          }
        },
        "IndexLevel": {
          "Description": "The index level.\n- **OFF**: No indexes are created.\n- **META**: Metadata indexes are created.\n- **ALL**: Full-text indexes are created.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "IndexLevel"
            ]
          }
        },
        "IndexUpdateTime": {
          "Description": "The time when the index was updated.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "IndexUpdateTime"
            ]
          }
        },
        "LatestReplicationTime": {
          "Description": "The time when the last remote backup was synchronized. This value is a UNIX timestamp. Unit: seconds.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "LatestReplicationTime"
            ]
          }
        },
        "PaymentType": {
          "Description": "PaymentType.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "PaymentType"
            ]
          }
        },
        "RedundancyType": {
          "Description": "The data redundancy type of the backup vault. Valid values:\n- **LRS**: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.\n- **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "RedundancyType"
            ]
          }
        },
        "Replication": {
          "Description": "Indicates whether the backup vault is a remote backup vault. Valid values:\n- **true**: The backup vault is a remote backup vault.\n- **false**: The backup vault is an on-premises backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Replication"
            ]
          }
        },
        "ReplicationProgress": {
          "Description": "The progress of data synchronization from the backup vault to the mirror vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ReplicationProgress"
            ]
          }
        },
        "ReplicationSourceRegionId": {
          "Description": "The ID of the region where the remote backup vault resides.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ReplicationSourceRegionId"
            ]
          }
        },
        "ReplicationSourceVaultId": {
          "Description": "The ID of the source vault that corresponds to the remote backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ReplicationSourceVaultId"
            ]
          }
        },
        "ResourceGroupId": {
          "Description": "The ID of the resource group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ResourceGroupId"
            ]
          }
        },
        "Retention": {
          "Description": "The retention period of the backup vault. Unit: days.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Retention"
            ]
          }
        },
        "SearchEnabled": {
          "Description": "Indicates whether the backup search feature is enabled.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "SearchEnabled"
            ]
          }
        },
        "SourceTypes": {
          "Description": "The information about the data source.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "SourceTypes"
            ]
          }
        },
        "StorageSize": {
          "Description": "The usage of the backup vault. Unit: bytes.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "StorageSize"
            ]
          }
        },
        "Tags": {
          "Description": "The tags of the backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Tags"
            ]
          }
        },
        "TrialInfo": {
          "Description": "The free trial information.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "TrialInfo"
            ]
          }
        },
        "UpdatedTime": {
          "Description": "The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "UpdatedTime"
            ]
          }
        },
        "VaultId": {
          "Description": "The ID of the backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "VaultId"
            ]
          }
        },
        "VaultName": {
          "Description": "The name of the backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "VaultName"
            ]
          }
        },
        "VaultStatusMessage": {
          "Description": "The status message that is returned when the backup vault is in the ERROR state. This parameter is available only for remote backup vaults. Valid values:\n- **UNKNOWN_ERROR*: An unknown error occurs.\n- **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for the source vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "VaultStatusMessage"
            ]
          }
        },
        "VaultStorageClass": {
          "Description": "The storage type of the backup vault. Valid value: **STANDARD**, which indicates standard storage.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "VaultStorageClass"
            ]
          }
        },
        "VaultType": {
          "Description": "The type of the backup vault. Valid value: **STANDARD**, which indicates a standard backup vault.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "VaultType"
            ]
          }
        }
      }
    }
  4. [作成] をクリックし、作成したスタックを実行します。

  5. 結果を表示します。

    image

  6. test-vaultという名前のバックアップボールトが作成されたら、API操作の呼び出し、SDKの実行、またはCloud backupコンソールでの操作の実行により、バックアップボールトを表示できます。image