All Products
Search
Document Center

Cloud Backup:UninstallBackupClients

Last Updated:Jun 11, 2026

Menguninstall Klien Cloud Backup dari satu atau beberapa Instance ECS.

Deskripsi operasi

  • This operation creates an asynchronous job at the backend and calls Cloud Assistant to uninstall a backup client from an ECS instance.

  • You can call the DescribeTask operation to query the execution result of an asynchronous job.

  • The timeout period of an asynchronous job is 15 minutes. We recommend that you call the DescribeTask operation to run the first query 30 seconds after you call the UninstallBackupClients operation to uninstall backup clients. Then, run the next queries at an interval of 30 seconds.

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

update

*All Resource

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

InstanceIds

object

No

ID Instance ECS. Anda dapat menentukan maksimal 20 Instance ECS.

["i-0xi5wj5*****v3j3bh2gj5"]

ClientIds

object

No

ID Klien Cloud Backup. Jumlah ID Klien Cloud Backup dan ID Instance ECS tidak boleh melebihi 20. Jika tidak, akan terjadi error.

["c-*********************"]

CrossAccountType

string

No

Apakah akan mencadangkan dan memulihkan data dalam akun Alibaba Cloud yang sama atau lintas akun Alibaba Cloud. Nilai valid:

  • SELF_ACCOUNT: Data dicadangkan dan dipulihkan dalam akun Alibaba Cloud yang sama.

  • CROSS_ACCOUNT: Data dicadangkan dan dipulihkan lintas akun Alibaba Cloud.

CROSS_ACCOUNT

CrossAccountUserId

integer

No

ID akun Alibaba Cloud sumber yang mengizinkan akun Alibaba Cloud saat ini untuk mencadangkan dan memulihkan data lintas akun Alibaba Cloud.

129349237xxxxx

CrossAccountRoleName

string

No

Nama Peran RAM yang dibuat dalam akun Alibaba Cloud sumber dan ditetapkan ke akun Alibaba Cloud saat ini untuk mengizinkan akun Alibaba Cloud saat ini mencadangkan dan memulihkan data lintas akun Alibaba Cloud.

BackupRole

Elemen respons

Element

Type

Description

Example

object

Code

string

The HTTP status code. The status code 200 indicates that the request is successful.

200

Message

string

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

successful

RequestId

string

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

TaskId

string

The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.

t-*********************

Success

boolean

Indicates whether the request is successful.

  • true: The request is successful.

  • false: The request fails.

true

InstanceStatuses

array<object>

The status of the ECS instance.

object

ValidInstance

boolean

Indicates whether a backup client can be installed on the ECS instance.

  • true: A backup client can be installed on the ECS instance.

  • false: A backup client cannot be installed on the ECS instance.

true

InstanceId

string

The ID of the ECS instance.

i-0xi5w***v3j3bh2gj5

ErrorCode

string

The error code. Valid values:

  • If the value is empty, the request is successful.

  • InstanceNotExists: The ECS instance does not exist.

  • InstanceNotRunning: The ECS instance is not running.

  • CloudAssistNotRunningOnInstance: Cloud Assistant is unavailable.

InstanceNotExists

Contoh

Respons sukses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.