DATASOURCE::HBR::Vault - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

O DATASOURCE::HBR::Vault consulta informações de um cofre de backup.

Sintaxe

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

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

VaultId

String

Sim

ID do cofre de backup.

Nenhuma.

RefreshOptions

String

Não

Sim

Política de atualização dos recursos de source de dados ao atualizar a pilha.

Valores válidos:

Never (padrão): não atualiza os recursos de source de dados ao atualizar a pilha.
Always: atualiza os recursos de source de dados ao atualizar a pilha.

Valores de retorno

Fn::GetAtt

Description: descrição do cofre de backup.
ResourceGroupId: ID do grupo de recursos.
TrialInfo: informações sobre o teste gratuito.
ReplicationSourceRegionId: ID da região do cofre de source.
IndexUpdateTime: horário da última atualização do índice.
VaultId: ID do cofre de backup.
Retention: período de retenção do cofre de backup.
Dedup: indica se o recurso de desduplicação está ativado.
VaultStatusMessage: mensagem de status retornada quando o cofre de backup apresenta o estado ERROR.
BytesDone: volume de dados em backup.
ReplicationProgress: progresso da sincronização de dados do cofre de backup para o cofre espelho.
PaymentType: método de faturamento.
BackupPlanStatistics: estatísticas dos planos de backup que utilizam este cofre.
Tags: tags do cofre de backup.
VaultName: nome do cofre de backup.
RedundancyType: tipo de redundância de dados do cofre de backup.
VaultStorageClass: classe de armazenamento do cofre de backup.
CreateTime: horário de criação do cofre de backup.
StorageSize: uso do cofre de backup.
ReplicationSourceVaultId: ID do cofre de source.
VaultType: tipo do cofre de backup.
LatestReplicationTime: horário da última sincronização do backup remoto.
Replication: indica se o cofre é um cofre de backup remoto.
IndexLevel: nível do índice.
UpdatedTime: horário da última atualização do cofre de backup.
SourceTypes: informações sobre as origens de dados.
IndexAvailable: indica se os índices estão disponíveis.
SearchEnabled: indica se o recurso de pesquisa de backup está ativado.

Exemplos

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

{
  "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"
        ]
      }
    }
  }
}