Gunakan CreateClients API untuk menerapkan klien backup batch di ECS - Cloud Backup - Alibaba Cloud - Cloud Backup

Menginstal satu atau beberapa klien Cloud Backup pada instans tertentu.

Deskripsi operasi

Before you call this operation, make sure that you fully understand the billing methods and pricing of Cloud Backup. For more information, see Billing methods and billable items.

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

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VaultId	string	Yes	ID penyimpanan cadangan.	v-0001ufe******kgm
AlertSetting	string	No	Pengaturan peringatan. Nilai valid: INHERITED, yang menunjukkan bahwa klien HBR mengirimkan notifikasi peringatan menggunakan metode yang sama dengan yang dikonfigurasi untuk penyimpanan cadangan.	INHERITED
ClientInfo	string	No	Informasi penginstalan klien HBR.	[ { "instanceId": "i-bp116lr****te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q**9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux****hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
UseHttps	boolean	No	Apakah akan mengirimkan data melalui HTTPS. Nilai valid: true: Mengirimkan data melalui HTTPS. false: Mengirimkan data melalui HTTP.	false
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-aekzvx7d3c4kpny
CrossAccountType	string	No	Tipe pencadangan. Nilai valid: SELF_ACCOUNT: Data dicadangkan dalam akun Alibaba Cloud yang sama. CROSS_ACCOUNT: Data dicadangkan lintas akun Alibaba Cloud.	CROSS_ACCOUNT
CrossAccountUserId	integer	No	ID akun Alibaba Cloud sumber yang mengizinkan akun Alibaba Cloud saat ini untuk mencadangkan data lintas akun Alibaba Cloud.	158975xxxxx4625
CrossAccountRoleName	string	No	Nama peran Resource Access Management (RAM) yang dibuat dalam akun Alibaba Cloud sumber dan ditetapkan ke akun Alibaba Cloud saat ini untuk mengizinkan akun Alibaba Cloud saat ini mencadangkan data lintas akun Alibaba Cloud.	hbrcrossrole

Elemen respons

Element	Type	Description	Example
	object
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
RequestId	string	The ID of the request.	4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskId	string	The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of an asynchronous job.	t-000h9x5t02vhyksf1x7k
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
InstanceStatuses	object
InstanceStatus	array<object>	The status of the ECS instance. If you specify more than one instance IDs in the request and the status of an ECS instance does not meet the requirements to install an HBR client, an error message is returned based on the value of this parameter.
	object	The status of the ECS instance. If you specify more than one instance IDs in the request and the status of an ECS instance does not meet the requirements to install an HBR client, an error message is returned based on the value of this parameter.
ValidInstance	boolean	Indicates whether an HBR client can be installed on the ECS instance. Valid values: true: An HBR client can be installed on the ECS instance. false: An HBR client cannot be installed on the ECS instance.	true
InstanceId	string	The ID of the ECS instance.	i-2zegp3cdu******uj9i

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
  "TaskId": "t-000h9x5t02vhyksf1x7k",
  "Success": true,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "ValidInstance": true,
        "InstanceId": "i-2zegp3cdu******uj9i"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.