Ikhtisar API DescribeClients untuk Backup SAP HANA - Cloud Backup - Alibaba Cloud - Cloud Backup

Menanyakan satu atau beberapa klien Cloud Backup yang memenuhi kondisi yang ditentukan.

Deskripsi operasi

Operasi ini hanya berlaku untuk pencadangan SAP HANA. Untuk klien Cloud Backup dari sumber data lainnya, panggil operasi DescribeBackupClients.

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:DescribeClients

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VaultId	string	No	ID dari vault pencadangan.	v-0001vk0z******xdyr
ClientId	string	No	ID dari klien Cloud Backup.	c-000ed600******6b0
PageNumber	integer	No	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 1 hingga 99. Nilai default: 10.	10
ClientType	string	No	Tipe klien Cloud Backup. Nilai yang valid: ECS_AGENT, yang menunjukkan klien pencadangan SAP HANA.	ECS_AGENT
SourceType	string	No	Tipe sumber data. Nilai yang valid:HANA, yang menunjukkan pencadangan SAP HANA.	HANA
ClusterId	string	No	ID dari instans SAP HANA.	cl-0005ni1******2l87
ResourceGroupId	string	No	ID dari grup sumber daya.	rg-acfmw6bxl7o5qyq

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	17189276-465D-5EF3-8FFD-0FF51B5A41A0
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false	true
Code	string	Kode respons. Kode status 200 menunjukkan bahwa permintaan berhasil.	200
Message	string	Pesan yang dikembalikan. Jika permintaan berhasil, "successful" akan dikembalikan. Jika permintaan gagal, pesan kesalahan akan dikembalikan.	successful
PageNumber	integer	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	Jumlah entri per halaman. Nilai yang valid: 1 hingga 99. Nilai default: 10.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	12
Clients	object
Client	array<object>	Klien Cloud Backup.
	object	Informasi klien.
Status	string	The status of the Cloud Backup client. Valid values: REGISTERED: The backup client is registered. ACTIVATED: The backup client is activated. DEACTIVATED: The backup client fails to be activated. INSTALLING: The backup client is being installed. INSTALL_FAILED: The backup client fails to be installed. NOT_INSTALLED: The backup client is not installed. UPGRADING: The backup client is being upgraded. UPGRADE_FAILED: The backup client fails to be upgraded. UNINSTALLING: The backup client is being uninstalled. UNINSTALL_FAILED: The backup client fails to be uninstalled. STOPPED: The backup client is out of service. UNKNOWN: The backup client is disconnected.	ACTIVATED
VaultId	string	The ID of the backup vault.	v-00029mx6o******n85lg
UseHttps	boolean	Indicates whether data is transmitted over HTTPS. Valid values: true: Data is transmitted over HTTPS. false: Data is transmitted over HTTP.	false
NetworkType	string	The network type. Valid values: CLASSIC: the classic network VPC: the virtual private cloud (VPC)	VPC
ClientName	string	The client name.	client-20211224-101226
ClientId	string	The ID of the Cloud Backup client.	c-00062uu******2fgj
AlertSetting	string	The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.	INHERITED
InstanceName	string	The name of the ECS instance.	swh-hbr
MaxVersion	string	The maximum version number of the Cloud Backup client.	1.11.23
CreatedTime	integer	The time when the Cloud Backup client was created.	1554347313
StatusMessage	string	The status information.	HANA_NOT_SUPPORT
ClientType	string	The type of the Cloud Backup client. Valid value: ECS_AGENT, which indicates an SAP HANA backup client.	ECS_AGENT
InstanceId	string	The instance ID.	i-wz9b6wya******n8yo
UpdatedTime	integer	The time when the Cloud Backup client was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
ClientVersion	string	The version number of the Cloud Backup client.	1.11.16
ClusterId	string	The ID of the SAP HANA instance.	cl-0008c48frr******ncpk
HeartBeatTime	integer	The latest heartbeat time of the Cloud Backup client. This value is a UNIX timestamp. Unit: seconds.	1554347313

Contoh

Respons sukses

JSONformat

{
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": {
    "Client": [
      {
        "Status": "ACTIVATED",
        "VaultId": "v-00029mx6o******n85lg",
        "UseHttps": false,
        "NetworkType": "VPC",
        "ClientName": "client-20211224-101226",
        "ClientId": "c-00062uu******2fgj",
        "AlertSetting": "INHERITED",
        "InstanceName": "swh-hbr",
        "MaxVersion": "1.11.23",
        "CreatedTime": 1554347313,
        "StatusMessage": "HANA_NOT_SUPPORT",
        "ClientType": "ECS_AGENT",
        "InstanceId": "i-wz9b6wya******n8yo",
        "UpdatedTime": 1554347313,
        "ClientVersion": "1.11.16",
        "ClusterId": "cl-0008c48frr******ncpk",
        "HeartBeatTime": 1554347313
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.