Daftar Gateway Backup dengan DescribeBackupGatewayList - DBS - Alibaba Cloud - Data Management

Meminta daftar gateway backup di Database Backup Service (DBS).

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

dbs:DescribeBackupGatewayList

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Region	string	Yes	Region dari instance DBS. Nilai yang valid: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Shanghai) cn-qingdao: China (Qingdao) cn-beijing: China (Beijing) cn-shenzhen: China (Shenzhen) cn-hongkong: China (Hong Kong) ap-southeast-1: Singapura cn-hangzhou-finance: Hangzhou Finance Cloud cn-shanghai-finance: Shanghai Finance Cloud cn-shenzhen-finance: Shenzhen Finance Cloud	cn-hangzhou
Identifier	string	No	Pengidentifikasi unik dari gateway backup. Anda dapat mencari beberapa gateway dengan memisahkan pengidentifikasi menggunakan koma (,).	7213527653217
PageSize	integer	No	Jumlah catatan pada setiap halaman. Nilai yang valid: 30 50 100 Catatan Nilai default adalah 30.	30
PageNum	integer	No	Nomor halaman. Nilai harus lebih besar dari atau sama dengan 0 dan tidak boleh melebihi nilai maksimum integer. Nilai default adalah 0.	1
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Ini mencegah permintaan duplikat.	ETnLKlblzczshOTUbOCzxxxxxxx

Elemen respons

Element	Type	Description	Example
	object
HttpStatusCode	integer	Kode status HTTP.	200
PageNum	integer	Nomor halaman.	1
RequestId	string	ID permintaan.	46361705-8531-492F-807E-A97E482DD4A1
ErrCode	string	Kode kesalahan.	Param.NotFound
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
ErrMessage	string	Pesan kesalahan.	The specified parameter %s value is not valid.
TotalPages	integer	Jumlah total halaman.	1
TotalElements	integer	Jumlah total gateway backup.	0
PageSize	integer	Jumlah catatan pada setiap halaman.	30
Items	object
BackupGateway	array<object>	Detail dari gateway backup.
	object
DisplayName	string	The display name of the backup gateway.	test
BackupGatewayCreateTime	integer	The time when the backup gateway was created. The value is a UNIX timestamp. Unit: milliseconds.	1554560477000
BackupGatewayId	string	The ID of the backup gateway.	2321313123
Region	string	The region.	cn-hangzhou
Identifier	string	The unique identifier of the backup gateway.	sgdsajhdgu
SourceEndpointInternetIP	string	The public IP address of the host where the backup gateway is installed.	XX.XX.XX.XX
BackupGatewayStatus	string	The status of the backup gateway. Valid values: ONLINE: The gateway is online. OFFLINE: The gateway is offline. STOPPED: The gateway is stopped. UPGRADING: The gateway is being upgraded.	ONLINE
SourceEndpointIntranetIP	string	The private IP address of the host where the backup gateway is installed.	XX.XX.XX.XX
LastHeartbeatTime	integer	The time of the last heartbeat. The value is a UNIX timestamp. Unit: milliseconds.	1554560477000
SourceEndpointHostname	string	The hostname of the host where the backup gateway is installed.	test

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "TotalPages": 1,
  "TotalElements": 0,
  "PageSize": 30,
  "Items": {
    "BackupGateway": [
      {
        "DisplayName": "test",
        "BackupGatewayCreateTime": 1554560477000,
        "BackupGatewayId": "2321313123",
        "Region": "cn-hangzhou",
        "Identifier": "sgdsajhdgu",
        "SourceEndpointInternetIP": "XX.XX.XX.XX",
        "BackupGatewayStatus": "ONLINE",
        "SourceEndpointIntranetIP": "XX.XX.XX.XX",
        "LastHeartbeatTime": 1554560477000,
        "SourceEndpointHostname": "test"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.