DATASOURCE::HBR::Vault_资源编排(ROS)-阿里云帮助中心

DATASOURCE::HBR::Vault类型用于获取单个备份仓库基础信息。

语法

{
  "Type": "DATASOURCE::HBR::Vault",
  "Properties": {
    "VaultId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

VaultId

String

是

备份仓库ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

Description：备份仓库描述信息。
ResourceGroupId：资源组的ID。
TrialInfo：免费试用信息。
ReplicationSourceRegionId：源仓库所属的地域ID。
IndexUpdateTime：索引更新的时间。
VaultId：备份仓库ID。
Retention：备份vault的保留期。
Dedup：显示是否启用重复数据删除特性。
VaultStatusMessage：备份仓库处于ERROR状态时返回的状态信息。
BytesDone：备份的数据量。
ReplicationProgress：从备份仓库到镜像仓库的数据同步进度。
PaymentType：付费类型。
BackupPlanStatistics：使用备份库的备份计划统计信息。
Tags：备份库的标签。
VaultName：备份仓库名称。
RedundancyType：备份仓库的数据冗余存储方式。
VaultStorageClass：备份仓库存储类型。
CreateTime：备份仓库创建的时间。
StorageSize：备份仓库的使用情况。
ReplicationSourceVaultId：源仓库ID。
VaultType：备份仓库类型。
LatestReplicationTime：最后一次远程备份同步的时间。
Replication：该备份仓库是否为远端备份仓库。
IndexLevel：索引级别。
UpdatedTime：备份仓库更新的时间。
SourceTypes：关于数据源的信息。
IndexAvailable：指示索引是否可用。
SearchEnabled：是否启用备份搜索特性。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultId:
    Type: String
    Description:
      en: The ID of the backup vault.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::HBR::Vault
    Properties:
      VaultId:
        Ref: VaultId
Outputs:
  Description:
    Description: The description of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  TrialInfo:
    Description: The free trial information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TrialInfo
  ReplicationSourceRegionId:
    Description: The ID of the region in which the source vault resides. This parameter is valid only for remote backup vaults.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReplicationSourceRegionId
  IndexUpdateTime:
    Description: The time when the index was updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IndexUpdateTime
  VaultId:
    Description: The ID of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VaultId
  Retention:
    Description: 'The retention period of the backup vault. Unit: days.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Retention
  Dedup:
    Description: Indicates whether the deduplication feature is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Dedup
  VaultStatusMessage:
    Description: The status message that is returned when the backup vault is in the ERROR state. This parameter is valid only for remote backup vaults.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VaultStatusMessage
  BytesDone:
    Description: 'The amount of data that is backed up. Unit: bytes.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BytesDone
  ReplicationProgress:
    Description: The progress of data synchronization from the backup vault to the mirror vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReplicationProgress
  PaymentType:
    Description: The payment type of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  BackupPlanStatistics:
    Description: The statistics of backup plans that use the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanStatistics
  Tags:
    Description: The tags of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  VaultName:
    Description: The name of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VaultName
  RedundancyType:
    Description: 'The data redundancy type of the backup vault. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RedundancyType
  VaultStorageClass:
    Description: Backup repository storage type. The value is only **STANDARD**, which indicates STANDARD storage.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VaultStorageClass
  CreateTime:
    Description: The creation time of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  StorageSize:
    Description: 'The usage of the backup vault. Unit: bytes.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageSize
  ReplicationSourceVaultId:
    Description: The ID of the source vault that corresponds to the remote backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReplicationSourceVaultId
  VaultType:
    Description: The type of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VaultType
  LatestReplicationTime:
    Description: 'The time when the last remote backup was synchronized. The value is a UNIX timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LatestReplicationTime
  Replication:
    Description: Indicates whether the backup vault is a remote backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Replication
  IndexLevel:
    Description: The index level.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IndexLevel
  UpdatedTime:
    Description: 'The time when the backup vault was updated. The value is a UNIX timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedTime
  SourceTypes:
    Description: The data source types of the backup vault.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceTypes
  IndexAvailable:
    Description: Indicates whether indexes are available. Indexes are available when they are not being updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IndexAvailable
  SearchEnabled:
    Description: Indicates whether the backup search feature is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SearchEnabled

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VaultId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the backup vault."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::HBR::Vault",
      "Properties": {
        "VaultId": {
          "Ref": "VaultId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "TrialInfo": {
      "Description": "The free trial information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TrialInfo"
        ]
      }
    },
    "ReplicationSourceRegionId": {
      "Description": "The ID of the region in which the source vault resides. This parameter is valid only for remote backup vaults.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicationSourceRegionId"
        ]
      }
    },
    "IndexUpdateTime": {
      "Description": "The time when the index was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IndexUpdateTime"
        ]
      }
    },
    "VaultId": {
      "Description": "The ID of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VaultId"
        ]
      }
    },
    "Retention": {
      "Description": "The retention period of the backup vault. Unit: days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Retention"
        ]
      }
    },
    "Dedup": {
      "Description": "Indicates whether the deduplication feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Dedup"
        ]
      }
    },
    "VaultStatusMessage": {
      "Description": "The status message that is returned when the backup vault is in the ERROR state. This parameter is valid only for remote backup vaults.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VaultStatusMessage"
        ]
      }
    },
    "BytesDone": {
      "Description": "The amount of data that is backed up. Unit: bytes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BytesDone"
        ]
      }
    },
    "ReplicationProgress": {
      "Description": "The progress of data synchronization from the backup vault to the mirror vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicationProgress"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "BackupPlanStatistics": {
      "Description": "The statistics of backup plans that use the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanStatistics"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "VaultName": {
      "Description": "The name of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VaultName"
        ]
      }
    },
    "RedundancyType": {
      "Description": "The data redundancy type of the backup vault. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RedundancyType"
        ]
      }
    },
    "VaultStorageClass": {
      "Description": "Backup repository storage type. The value is only **STANDARD**, which indicates STANDARD storage.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VaultStorageClass"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "StorageSize": {
      "Description": "The usage of the backup vault. Unit: bytes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageSize"
        ]
      }
    },
    "ReplicationSourceVaultId": {
      "Description": "The ID of the source vault that corresponds to the remote backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplicationSourceVaultId"
        ]
      }
    },
    "VaultType": {
      "Description": "The type of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VaultType"
        ]
      }
    },
    "LatestReplicationTime": {
      "Description": "The time when the last remote backup was synchronized. The value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LatestReplicationTime"
        ]
      }
    },
    "Replication": {
      "Description": "Indicates whether the backup vault is a remote backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Replication"
        ]
      }
    },
    "IndexLevel": {
      "Description": "The index level.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IndexLevel"
        ]
      }
    },
    "UpdatedTime": {
      "Description": "The time when the backup vault was updated. The value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedTime"
        ]
      }
    },
    "SourceTypes": {
      "Description": "The data source types of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceTypes"
        ]
      }
    },
    "IndexAvailable": {
      "Description": "Indicates whether indexes are available. Indexes are available when they are not being updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IndexAvailable"
        ]
      }
    },
    "SearchEnabled": {
      "Description": "Indicates whether the backup search feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SearchEnabled"
        ]
      }
    }
  }
}