Parameter DescribeVaults API dan pemfilteran vault - Cloud Backup - Alibaba Cloud - Cloud Backup

Mendeskripsikan satu atau beberapa penyimpanan cadangan yang memenuhi kriteria tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

hbr:DescribeVaults

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VaultId	string	No	ID penyimpanan cadangan.	v-*********************
VaultRegionId	string	No	ID wilayah tempat penyimpanan cadangan berada.	cn-shanghai
Status	string	No	Status penyimpanan cadangan. UNKNOWN: Status tidak diketahui. INITIALIZING: Penyimpanan cadangan sedang diinisialisasi. CREATED: Penyimpanan cadangan telah dibuat. ERROR: Terjadi error.	CREATED
PageNumber	integer	No	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 99. Nilai default: 10.	10
VaultType	string	No	Tipe penyimpanan cadangan. Nilai valid: STANDARD: penyimpanan cadangan standar. Tipe penyimpanan cadangan ini dapat digunakan untuk pencadangan file ECS, pencadangan OSS, dan pencadangan NAS. OTS_BACKUP: penyimpanan cadangan Tablestore. Tipe penyimpanan cadangan ini dikhususkan untuk pencadangan Tablestore.	STANDARD
Tag	array<object>	No	Tag. Anda dapat menentukan maksimal 20 tag.	6a745bceffb042959b3b5206d6f12ad1
	object	No	The tag.
Key	string	No	The key of the tag.	key1
Value	string	No	The value of the tag.	value1
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-*********************
VaultName	string	No	Nama penyimpanan cadangan. Nama harus terdiri dari 1 hingga 64 karakter.	vaultname
VaultOwnerId	integer	No	ID akun Alibaba Cloud yang memiliki penyimpanan cadangan.	144******732
Replication	boolean	No	Apakah akan mengkueri penyimpanan cadangan yang digunakan sebagai tujuan replikasi.	true

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
Code	string	The return code. A value of 200 indicates that the request was successful.	200
Message	string	The message that is returned. If the request is successful, "successful" is returned. If the request fails, an error message is returned.	successful
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of backup vaults that are returned.	8
Vaults	object
Vault	array<object>	The list of backup vaults.	{'Vault': []}
	array<object>	The list of backup vaults.
Status	string	The status of the backup vault. UNKNOWN: The status is unknown. INITIALIZING: The backup vault is being initialized. CREATED: The backup vault is 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 data deduplication 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, which indicates Standard storage.	STANDARD
Retention	integer	The retention period of the backup vault in 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 storage usage of the backup vault. Unit: bytes.	10
LatestReplicationTime	integer	The time of the last geo-redundancy synchronization. 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 image repository is already 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 OSS bucket that is used by the backup vault.	hbr-0005i51******t58
SearchEnabled	boolean	Indicates whether backup search 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 tag key cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`. The tag key cannot be an empty string.	aaa
Value	string	The tag value of the vault. The tag value cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`. The tag value cannot be an empty string.	a1
SourceTypes	object
SourceType	array	The types of data sources that are backed up in the backup vault.
	string	The type of the data source.	ECS_FILE
ReplicationProgress	object	The data synchronization progress of the image repository.
HistoricalReplicationProgress	integer	The synchronization progress of historical data in the image repository. Valid values: 0 to 100.	100
NewReplicationProgress	integer	The last synchronization time of incremental data in the image repository.	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.	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 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 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 free trial vault is released.	1594965600
TrialExpireTime	integer	The expiration time of the free trial.	1584597600
KeepAfterTrialExpiration	boolean	Indicates whether the 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: The backup vault is not encrypted. HBR_PRIVATE: The backup vault is encrypted using a key that is provided by HBR. This is the default value. KMS: The backup vault is encrypted using a key from 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: Data is not compressed. SNAPPY: Data is compressed using the SNAPPY algorithm. ZSTD: Data is compressed using the Zstandard algorithm, which 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 the redundant data of each object 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 the multi-zone mechanism to distribute user data across three zones within the same region. This ensures that data can still be accessed if a zone becomes unavailable.	LRS
KmsKeyId	string	The customer master key (CMK) or alias of the CMK that is used for encryption in KMS. 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 layer. Unit: bytes.	1024000
ArchiveBytesDone	integer	The backup data size of the archive layer. Unit: bytes.	1024000
ReplicationSourceVault	boolean	Indicates whether the vault is the source vault of a geo-redundant vault. true: The vault is the source vault of a geo-redundant vault. false: The vault is not the source vault of a geo-redundant vault.	false
ReplicationTargetRegionId	string	The destination region of the geo-redundant vault.	cn-shanghai
VaultOwnerId	integer		123***7890
ReplicationTargetVaultId	string		v-123***7890
ReplicationSourceOwnerId	integer		123***7890
ReplicationTargetOwnerId	integer		123***7890
ReplicationStatus	string		RUNNING
RsTargetAccountIds	object
RsTargetAccountId	array
	integer		123***7890

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.