DescribeVaults - - Centre de documentation Alibaba Cloud

Obtient les informations sur un ou plusieurs coffres de sauvegarde répondant aux conditions spécifiées.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

hbr:DescribeVaults

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
VaultId	string	Non	L'identifiant du coffre de sauvegarde.	v-*********************
VaultRegionId	string	Non	L'identifiant de la région du coffre de sauvegarde.	cn-shanghai
Status	string	Non	L'état du coffre de sauvegarde. Valeurs valides : UNKNOWN : inconnu INITIALIZING : en cours d'initialisation CREATED : créé ERROR : erreur	CREATED
PageNumber	integer	Non	Le numéro de page. Les pages commencent à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur minimale : 1. Valeur maximale : 99. Valeur par défaut : 10.	10
VaultType	string	Non	Le type de coffre de sauvegarde. Valeurs valides :	STANDARD
Tag	array<object>	Non	Les informations de balise. Un maximum de 20 balises sont prises en charge.	6a745bceffb042959b3b5206d6f12ad1
	object	Non	Les informations de balise.
Key	string	Non	La clé de la balise.	key1
Value	string	Non	La valeur de la balise.	value1
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-*********************
VaultName	string	Non	Le nom du coffre de sauvegarde. Le nom doit comporter entre 1 et 64 caractères.	vaultname
VaultOwnerId	integer	Non	L'identifiant du compte auquel le coffre de sauvegarde appartient.	144******732
Replication	boolean	Non	Indique si les coffres cibles de réplication doivent être interrogés.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indique si la requête a réussi.	true
Code	string	Le code de retour. Une valeur de 200 indique un succès.	200
Message	string	Le message renvoyé. La valeur « successful » est renvoyée pour une requête réussie. Un message d'erreur est renvoyé en cas d'échec de la requête.	successful
PageNumber	integer	Le numéro de page. Les pages commencent à 1. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées par page. Valeur minimale : 1. Valeur maximale : 99. Valeur par défaut : 10.	10
TotalCount	integer	Le nombre total de coffres de sauvegarde renvoyés.	8
Vaults	object		{'Vault': []}
Vault	array<object>	La liste des coffres de sauvegarde.	{'Vault': []}
	array<object>	La liste des coffres de sauvegarde.
Status	string	The status of the backup vault. UNKNOWN: The status is unknown. INITIALIZING: The backup vault is being initialized. CREATED: The backup vault has been created. ERROR: An error occurred.	CREATED
VaultId	string	The ID of the backup vault.	v-*********************
ChargeType	string	The billing method of the backup vault.	FREE
VaultType	string	The type of the backup vault. The value is fixed as STANDARD, which indicates a standard backup vault.	STANDARD
Dedup	boolean	Indicates whether the deduplication feature is enabled.	true
ReplicationSourceVaultId	string	The ID of the source vault for geo-redundancy.	v-*********************
IndexUpdateTime	integer	The time when the index was updated.	1639645628
Description	string	The description of the vault.	vault description
VaultStorageClass	string	The storage class of the backup vault. The value is fixed as STANDARD.	STANDARD
Retention	integer	The retention period of the backup vault. Unit: days.	2
CreatedTime	integer	The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.	1554347313
IndexLevel	string	The index level. OFF: No index is created. META: A metadata index is created. ALL: A full-text index is created.	OFF
VaultName	string	The name of the backup vault.	vaultname
StorageSize	integer	The usage of the backup vault. Unit: bytes.	10
LatestReplicationTime	integer	The time of the last geo-redundancy sync. This value is a UNIX timestamp. Unit: seconds.	1554347313
VaultStatusMessage	string	The error message for the geo-redundant vault. This parameter is valid only for geo-redundant vaults. Valid values: UNKNOWN_ERROR: An unknown error occurred. SOURCE_VAULT_ALREADY_HAS_REPLICATION: Another replication destination is configured for the source vault.	SOURCE_VAULT_ALREADY_HAS_REPLICATION
Replication	boolean	Indicates whether the vault is a geo-redundant vault. true: The vault is a geo-redundant vault. false: The vault is a local backup vault.	false
ReplicationSourceRegionId	string	The ID of the region where the source vault of the geo-redundant vault resides. This parameter is valid only for geo-redundant vaults.	cn-shanghai
VaultRegionId	string	The ID of the region where the backup vault resides.	cn-shanghai
UpdatedTime	integer	The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
ResourceGroupId	string	The ID of the resource group.	rg-*********************
BucketName	string	The name of the Object Storage Service (OSS) bucket used for the backup vault.	hbr-0005i51******t58
SearchEnabled	boolean	Indicates whether the backup search feature is enabled.	true
IndexAvailable	boolean	Indicates whether the index is available. An index is available when it is not being updated.	true
BytesDone	integer	The backup data size. Unit: bytes.	20
Tags	object
Tag	array<object>	The tags of the backup vault.
	object	The tags of the backup vault.
Key	string	The tag key of the vault. The key cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`. The key cannot be an empty string.	aaa
Value	string	The tag value of the vault. The value cannot start with `aliyun` or `acs:`. The value cannot contain `http://` or `https://`. The value cannot be an empty string.	a1
SourceTypes	object
SourceType	array	The types of data sources that are backed up to the vault.
	string	The type of the data source.	ECS_FILE
ReplicationProgress	object	The replication progress of the backup vault.
HistoricalReplicationProgress	integer	The replication progress of historical data in the backup vault. Valid values: 0 to 100.	100
NewReplicationProgress	integer	The most recent replication time of incremental data in the backup vault.	1579413159
BackupPlanStatistics	object	The statistics of backup plans for the backup vault.
Oracle	integer	The number of Oracle backup plans.	1
LocalFile	integer	The number of backup plans for on-premises servers.	1
Nas	integer	The number of NAS backup plans.	1
CommonNas	integer	The number of backup plans for general-purpose NAS file systems.	1
Isilon	integer	The number of Isilon backup plans.	1
Oss	integer	The number of OSS backup plans.	1
SqlServer	integer	The number of SQL Server backup plans.	1
Csg	integer	The number of Cloud Storage Gateway (CSG) backup plans.	1
EcsFile	integer	The number of ECS file backup plans.	1
MySql	integer	The number of MySQL backup plans.	1
EcsHana	integer	The number of SAP HANA backup plans.	1
LocalVm	integer	The number of backup plans for on-premises virtual machines.	1
Ots	integer	The number of Tablestore backup plans.	1
Archive	integer	The number of archive plans.	1
CommonFileSystem	integer	The number of Cloud Paralleled File System (CPFS) backup plans.	1
TrialInfo	object	The free trial properties.
TrialStartTime	integer	The start time of the free trial.	1579413159
TrialVaultReleaseTime	integer	The time when the trial backup vault is released.	1594965600
TrialExpireTime	integer	The expiration time of the free trial.	1584597600
KeepAfterTrialExpiration	boolean	Indicates whether the backup vault is converted to a pay-as-you-go vault after the free trial ends.	true
EncryptType	string	The encryption type of the backup vault. NONE: No encryption is used. HBR_PRIVATE: The backup vault is encrypted using a key that is managed by Hybrid Backup Recovery (HBR). This is the default value. KMS: The backup vault is encrypted using a key that is managed by Key Management Service (KMS).	HBR_PRIVATE
WormEnabled	boolean	Indicates whether backup locking is enabled.	true
SnapshotCount	integer	The number of snapshots in the vault.	0
CompressionAlgorithm	string	The compression algorithm that is used for the backup vault. Valid values: DISABLED: Compression is disabled. SNAPPY: The SNAPPY algorithm is used. ZSTD: The Zstandard algorithm is used. Zstandard is a fast, lossless compression algorithm.	ZSTD
RedundancyType	string	The data redundancy type of the backup vault. Valid values: LRS: locally redundant storage (LRS). HBR stores redundant copies of your data on multiple devices in the same zone to ensure data durability and availability in case of hardware failures. ZRS: zone-redundant storage (ZRS). HBR uses a multi-zone mechanism to distribute your data across three zones within the same region. This ensures that your data remains accessible even if a zone becomes unavailable.	LRS
KmsKeyId	string	The ID of the customer master key (CMK) or the alias of the CMK that is used for KMS encryption. This parameter is required only if you set EncryptType to KMS.	alias/acs/acm
ChargedStorageSize	integer	The billable storage usage of the archive vault. Unit: bytes.	1024000
ArchiveStorageSize	integer	The billable storage usage of the Archive storage class. Unit: bytes.	1024000
ArchiveBytesDone	integer	The backup data size of the Archive storage class. Unit: bytes.	1024000
ReplicationSourceVault	boolean	Indicates whether the vault is a source vault for geo-redundancy. true: The vault is a source vault for geo-redundancy. false: The vault is not a source vault for geo-redundancy.	false
ReplicationTargetRegionId	string	The destination region for geo-redundancy.	cn-shanghai
VaultOwnerId	integer	The ID of the account that owns the data store.	123***7890
ReplicationTargetVaultId	string	The ID of the replication destination vault.	v-123***7890
ReplicationSourceOwnerId	integer	The ID of the source account for replication.	123***7890
ReplicationTargetOwnerId	integer	The ID of the account that owns the replication destination vault.	123***7890
ReplicationStatus	string	The replication status of the replication destination vault.	RUNNING
RsTargetAccountIds	object
RsTargetAccountId	array	The destination account for resource sharing.
	integer	The destination account for resource sharing.	123***7890

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Vaults": {
    "Vault": [
      {
        "Status": "CREATED",
        "VaultId": "v-*********************",
        "ChargeType": "FREE",
        "VaultType": "STANDARD",
        "Dedup": true,
        "ReplicationSourceVaultId": "v-*********************",
        "IndexUpdateTime": 1639645628,
        "Description": "vault description",
        "VaultStorageClass": "STANDARD",
        "Retention": 2,
        "CreatedTime": 1554347313,
        "IndexLevel": "OFF",
        "VaultName": "vaultname",
        "StorageSize": 10,
        "LatestReplicationTime": 1554347313,
        "VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
        "Replication": false,
        "ReplicationSourceRegionId": "cn-shanghai",
        "VaultRegionId": "cn-shanghai",
        "UpdatedTime": 1554347313,
        "ResourceGroupId": "rg-*********************",
        "BucketName": "hbr-0005i51******t58",
        "SearchEnabled": true,
        "IndexAvailable": true,
        "BytesDone": 20,
        "Tags": {
          "Tag": [
            {
              "Key": "aaa",
              "Value": "a1"
            }
          ]
        },
        "SourceTypes": {
          "SourceType": [
            "ECS_FILE"
          ]
        },
        "ReplicationProgress": {
          "HistoricalReplicationProgress": 100,
          "NewReplicationProgress": 1579413159
        },
        "BackupPlanStatistics": {
          "Oracle": 1,
          "LocalFile": 1,
          "Nas": 1,
          "CommonNas": 1,
          "Isilon": 1,
          "Oss": 1,
          "SqlServer": 1,
          "Csg": 1,
          "EcsFile": 1,
          "MySql": 1,
          "EcsHana": 1,
          "LocalVm": 1,
          "Ots": 1,
          "Archive": 1,
          "CommonFileSystem": 1
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "EncryptType": "HBR_PRIVATE",
        "WormEnabled": true,
        "SnapshotCount": 0,
        "CompressionAlgorithm": "ZSTD",
        "RedundancyType": "LRS",
        "KmsKeyId": "alias/acs/acm",
        "ChargedStorageSize": 1024000,
        "ArchiveStorageSize": 1024000,
        "ArchiveBytesDone": 1024000,
        "ReplicationSourceVault": false,
        "ReplicationTargetRegionId": "cn-shanghai",
        "VaultOwnerId": 0,
        "ReplicationTargetVaultId": "v-123***7890",
        "ReplicationSourceOwnerId": 0,
        "ReplicationTargetOwnerId": 0,
        "ReplicationStatus": "RUNNING",
        "RsTargetAccountIds": {
          "RsTargetAccountId": [
            0
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.