DescribeVaults - - 阿里云

Mengambil informasi satu atau beberapa penyimpanan cadangan (backup vault) 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 dari backup vault.	v-*********************
VaultRegionId	string	No	ID wilayah tempat backup vault berada.	cn-shanghai
Status	string	No	Status backup vault. UNKNOWN: Status tidak diketahui. INITIALIZING: Backup vault sedang diinisialisasi. CREATED: Backup vault 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 backup vault. Nilai valid: STANDARD: backup vault standar. Tipe vault ini dapat digunakan untuk backup file ECS, backup OSS, dan backup NAS. OTS_BACKUP: backup vault Tablestore. Tipe vault ini hanya dapat digunakan untuk backup Tablestore. Tablestore memerlukan tipe vault ini.	STANDARD
Tag	array<object>	No	Tag. Anda dapat menentukan maksimal 20 tag.	6a745bceffb042959b3b5206d6f12ad1
	object	No	Informasi tag.
Key	string	No	Kunci tag.	key1
Value	string	No	Nilai tag.	value1
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-*********************
VaultName	string	No	Nama backup vault. Nama harus terdiri dari 1 hingga 64 karakter.	vaultname

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Menunjukkan apakah permintaan berhasil. true: Permintaan berhasil. false: Permintaan gagal.	true
Code	string	Kode respons. Nilai 200 menunjukkan bahwa permintaan berhasil.	200
Message	string	Pesan yang dikembalikan. Jika permintaan berhasil, "successful" dikembalikan. Jika permintaan gagal, pesan error dikembalikan.	successful
PageNumber	integer	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	Jumlah entri per halaman. Nilai valid: 1 hingga 99. Nilai default: 10.	10
TotalCount	integer	Jumlah total backup vault yang dikembalikan.	8
Vaults	object
Vault	array<object>	Daftar backup vault.	{'Vault': []}
	array<object>	Daftar backup vault.
Status	string	Status backup vault. UNKNOWN: Status tidak diketahui. INITIALIZING: Backup vault sedang diinisialisasi. CREATED: Backup vault telah dibuat. ERROR: Terjadi error.	CREATED
VaultId	string	ID backup vault.	v-*********************
ChargeType	string	Metode penagihan backup vault.	FREE
VaultType	string	Tipe backup vault. Nilainya tetap STANDARD, yang menunjukkan backup vault standar.	STANDARD
Dedup	boolean	Menunjukkan apakah deduplikasi data diaktifkan.	true
ReplicationSourceVaultId	string	ID vault sumber untuk geo-redundansi.	v-*********************
IndexUpdateTime	integer	Waktu saat indeks diperbarui.	1639645628
Description	string	Deskripsi vault.	vault description
VaultStorageClass	string	Kelas penyimpanan backup vault. Nilainya tetap STANDARD, yang menunjukkan penyimpanan Standar.	STANDARD
Retention	integer	Periode retensi backup vault dalam hari.	2
CreatedTime	integer	Waktu saat backup vault dibuat. Nilai ini merupakan stempel waktu UNIX. Satuan: detik.	1554347313
IndexLevel	string	Tingkat indeks. OFF: Tidak ada indeks yang dibuat. META: Indeks metadata dibuat. ALL: Indeks teks penuh dibuat.	OFF
VaultName	string	Nama backup vault.	vaultname
StorageSize	integer	Penggunaan penyimpanan backup vault. Satuan: byte.	10
LatestReplicationTime	integer	Waktu sinkronisasi geo-redundansi terakhir. Nilai ini merupakan stempel waktu UNIX. Satuan: detik.	1554347313
VaultStatusMessage	string	Pesan error untuk vault geo-redundan. Parameter ini hanya berlaku untuk vault geo-redundan. Nilai valid: UNKNOWN_ERROR: Terjadi error yang tidak diketahui. SOURCE_VAULT_ALREADY_HAS_REPLICATION: Repository image lain sudah dikonfigurasi untuk vault sumber.	SOURCE_VAULT_ALREADY_HAS_REPLICATION
Replication	boolean	Menunjukkan apakah vault merupakan vault geo-redundan. true: Vault adalah vault geo-redundan. false: Vault adalah vault cadangan lokal.	false
ReplicationSourceRegionId	string	ID wilayah tempat vault sumber dari vault geo-redundan berada. Parameter ini hanya berlaku untuk vault geo-redundan.	cn-shanghai
VaultRegionId	string	ID wilayah tempat backup vault berada.	cn-shanghai
UpdatedTime	integer	Waktu saat backup vault diperbarui. Nilai ini merupakan stempel waktu UNIX. Satuan: detik.	1554347313
ResourceGroupId	string	ID kelompok sumber daya.	rg-*********************
BucketName	string	Nama Bucket OSS yang digunakan oleh backup vault.	hbr-0005i51******t58
SearchEnabled	boolean	Menunjukkan apakah pencarian backup diaktifkan.	true
IndexAvailable	boolean	Menunjukkan apakah indeks tersedia. Indeks tersedia ketika tidak sedang diperbarui.	true
BytesDone	integer	Ukuran data cadangan. Satuan: byte.	20
Tags	object
Tag	array<object>	Tag dari backup vault.
	object	Tag dari backup vault.
Key	string	Kunci tag vault. Kunci tag tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`. Kunci tag tidak boleh berupa string kosong.	aaa
Value	string	Nilai tag vault. Nilai tag tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`. Nilai tag tidak boleh berupa string kosong.	a1
SourceTypes	object
SourceType	array	Tipe sumber data yang dicadangkan dalam backup vault.
	string	Tipe sumber data.	ECS_FILE
ReplicationProgress	object	Kemajuan sinkronisasi data repository image.
HistoricalReplicationProgress	integer	Kemajuan sinkronisasi data historis dalam repository image. Nilai valid: 0 hingga 100.	100
NewReplicationProgress	integer	Waktu sinkronisasi terakhir data inkremental dalam repository image.	1579413159
BackupPlanStatistics	object	Statistik rencana cadangan untuk backup vault.
Oracle	integer	Jumlah rencana cadangan Oracle.	1
LocalFile	integer	Jumlah rencana cadangan untuk server on-premises.	1
Nas	integer	Jumlah rencana cadangan NAS.	1
CommonNas	integer	Jumlah rencana cadangan untuk NAS general-purpose.	1
Isilon	integer	Jumlah rencana cadangan Isilon.	1
Oss	integer	Jumlah rencana cadangan OSS.	1
SqlServer	integer	Jumlah rencana cadangan SQL Server.	1
Csg	integer	Jumlah rencana cadangan Cloud Storage Gateway.	1
EcsFile	integer	Jumlah rencana cadangan file ECS.	1
MySql	integer	Jumlah rencana cadangan MySQL.	1
EcsHana	integer	Jumlah rencana cadangan SAP HANA.	1
LocalVm	integer	Jumlah rencana cadangan untuk mesin virtual on-premises.	1
Ots	integer	Jumlah rencana cadangan Tablestore.	1
Archive	integer	Jumlah rencana arsip.	1
CommonFileSystem	integer	Jumlah rencana cadangan CPFS.	1
TrialInfo	object	Properti uji coba gratis.
TrialStartTime	integer	Waktu mulai uji coba gratis.	1579413159
TrialVaultReleaseTime	integer	Waktu saat vault uji coba gratis dilepas.	1594965600
TrialExpireTime	integer	Waktu kedaluwarsa uji coba gratis.	1584597600
KeepAfterTrialExpiration	boolean	Menunjukkan apakah vault dikonversi menjadi vault bayar sesuai penggunaan setelah uji coba gratis berakhir.	true
EncryptType	string	Tipe enkripsi backup vault. NONE: Backup vault tidak dienkripsi. HBR_PRIVATE: Backup vault dienkripsi menggunakan kunci yang disediakan oleh HBR. Ini adalah nilai default. KMS: Backup vault dienkripsi menggunakan kunci dari Key Management Service (KMS).	HBR_PRIVATE
WormEnabled	boolean	Menunjukkan apakah penguncian backup diaktifkan.	true
SnapshotCount	integer	Jumlah snapshot dalam vault.	0
CompressionAlgorithm	string	Algoritma kompresi yang digunakan untuk backup vault. Nilai valid: DISABLED: Data tidak dikompresi. SNAPPY: Data dikompresi menggunakan algoritma SNAPPY. ZSTD: Data dikompresi menggunakan algoritma Zstandard, yaitu algoritma kompresi tanpa kehilangan data yang cepat.	ZSTD
RedundancyType	string	Tipe redundansi data backup vault. Nilai valid: LRS: penyimpanan redundan lokal (LRS). HBR menyimpan data redundan setiap objek pada beberapa perangkat di zona yang sama untuk memastikan ketahanan dan ketersediaan data jika terjadi kegagalan perangkat keras. ZRS: penyimpanan redundan zona (ZRS). HBR menggunakan mekanisme multi-zona untuk mendistribusikan data pengguna di tiga zona dalam wilayah yang sama. Ini memastikan data tetap dapat diakses jika suatu zona tidak tersedia.	LRS
KmsKeyId	string	Kunci master pelanggan (CMK) atau alias CMK yang digunakan untuk enkripsi di KMS. Parameter ini wajib ditentukan hanya jika Anda mengatur EncryptType ke KMS.	alias/acs/acm
ChargedStorageSize	integer	Penggunaan penyimpanan yang dapat ditagih dari vault arsip. Satuan: byte.	1024000
ArchiveStorageSize	integer	Penggunaan penyimpanan yang dapat ditagih dari lapisan arsip. Satuan: byte.	1024000
ArchiveBytesDone	integer	Ukuran data cadangan dari lapisan arsip. Satuan: byte.	1024000
ReplicationSourceVault	boolean	Menunjukkan apakah vault merupakan vault sumber dari vault geo-redundan. true: Vault adalah vault sumber dari vault geo-redundan. false: Vault bukan vault sumber dari vault geo-redundan.	false
ReplicationTargetRegionId	string	Wilayah tujuan vault geo-redundan.	cn-shanghai
VaultOwnerId	integer
ReplicationTargetVaultId	string
ReplicationSourceOwnerId	integer
ReplicationTargetOwnerId	integer
ReplicationStatus	string
RsTargetAccountIds	object
RsTargetAccountId	array
	integer

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": "",
        "ReplicationSourceOwnerId": 0,
        "ReplicationTargetOwnerId": 0,
        "ReplicationStatus": "",
        "RsTargetAccountIds": {
          "RsTargetAccountId": [
            0
          ]
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.