Gunakan API DescribeBackupClients untuk Daftar Klien Backup ECS - Cloud Backup - Alibaba Cloud - Cloud Backup

Mengkueri informasi satu atau beberapa klien cadangan yang memenuhi kondisi 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:DescribeBackupClients

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
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
ClientType	string	Yes	Tipe klien cadangan. Nilai valid: ECS_CLIENT: klien cadangan file ECS. CONTAINER_CLIENT: klien cadangan kontainer. LOCAL_CLIENT: klien untuk cadangan NAS, cadangan CPFS, pengarsipan data, atau sinkronisasi data. Valid values: CONTAINER_CLIENT : CONTAINER_CLIENT. LOCAL_CLIENT : LOCAL_CLIENT. ECS_CLIENT : ECS_CLIENT.	ECS_CLIENT
ClusterId	string	No	ID kluster cadangan.	cl-000ge4wa61b4d337xblq
ClientIds	array	No	Daftar ID klien cadangan.	["c-*********************"]
	string	No	The backup client ID.	c-*********************
InstanceIds	array	No	Daftar ID Instance ECS.	["i-*********************"]
	string	No	The ECS instance ID.	i-*********************
Tag	array<object>	No	Tag yang ditambahkan ke sumber daya.	33738719#
	object	No	The tag information.
Key	string	No	The tag key of the repository. N can be an integer from 1 to 20. The tag key cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`. The tag key cannot be an empty string.	TestKey
Value	string	No	The tag value of the repository. N can be an integer from 1 to 20. The tag value cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`. The tag value cannot be an empty string.	TestValue
CrossAccountType	string	No	Tipe cadangan lintas akun. Nilai valid: SELF_ACCOUNT: cadangan akun saat ini CROSS_ACCOUNT: cadangan lintas akun.	CROSS_ACCOUNT
CrossAccountUserId	integer	No	ID akun sumber untuk cadangan lintas akun.	129374672382xxxx
CrossAccountRoleName	string	No	Nama peran RAM yang dibuat di akun sumber untuk cadangan lintas akun.	hbrcrossrole
Filters	array<object>	No	Filter yang digunakan untuk mengkueri sumber daya.
	object	No	The filter.
Key	string	No	The key of the filter.	InstanceId
Values	array	No	The values of the filter.
	string	No	The value of the filter.	i-*********************

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
Code	string	The return code. A value of 200 indicates that the request was successful.	200
Message	string	The message that is returned. If the request is successful, `successful` is returned. If the request fails, an error message is returned.	successful
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of backup clients that meet the specified conditions.	8
Clients	array<object>	The list of backup clients.	{'Client': []}
	array<object>
Status	string	The status of the backup client. Valid values: REGISTERED: The client is registered. ACTIVATED: The client is activated. DEACTIVATED: The client is deactivated. INSTALLING: The client is being installed. INSTALL_FAILED: The installation failed. NOT_INSTALLED: The client is not installed. UPGRADING: The client is being upgraded. UPGRADE_FAILED: The upgrade failed. UNINSTALLING: The client is being uninstalled. UNINSTALL_FAILED: The uninstallation failed. STOPPED: The client service is stopped. UNKNOWN: The client is disconnected.	ACTIVATED
BackupStatus	string	The protection status of the backup client. Valid values: UNPROTECTED: The server is not protected. PROTECTED: The server is protected.	PROTECTED
ArchType	string	This parameter is returned only if ClientType is set to ECS_CLIENT. This parameter indicates the system architecture of the host where the backup client is deployed. Valid values: amd64 386	amd64
ClientId	string	The backup client ID.	c-*********************
MaxClientVersion	string	The latest version number of the backup client.	2.4.5
PrivateIpV4	string	This parameter is returned only if ClientType is set to ECS_CLIENT. This parameter indicates the private IP address of the ECS instance.	192.168.1.1
InstanceName	string	This parameter is returned only if ClientType is set to ECS_CLIENT. This parameter indicates the name of the ECS instance.	instancename
CreatedTime	integer	The time when the backup client was created. This value is a UNIX timestamp. Unit: seconds.	1554347313
LastHeartBeatTime	integer	The last heartbeat time of the backup client. This value is a UNIX timestamp. Unit: seconds.	1554347313
ClientType	string	The type of the backup client. The value ECS_CLIENT indicates an ECS file backup client.	ECS_CLIENT
Hostname	string	The hostname of the host where the backup client is deployed.	hostname
InstanceId	string	The instance ID. If the client is an ECS file backup client, this parameter indicates the ID of the ECS instance. If the client is a local file backup client, this parameter indicates the hardware fingerprint that is generated based on system information.	i-*********************
Appliance	boolean	Indicates whether the client is a backup-archive all-in-one machine. true: The client is a backup-archive all-in-one machine. false: The client is not a backup-archive all-in-one machine.	false
UpdatedTime	integer	The time when the backup client was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
OsType	string	This parameter is returned only if ClientType is set to ECS_CLIENT. This parameter indicates the operating system type of the client. Valid values: windows linux	linux
ZoneId	string	This parameter is returned only if ClientType is set to ECS_CLIENT. This parameter indicates the zone ID.	cn-hangzhou-f
ClientVersion	string	The version number of the backup client.	2.4.5
Tags	array<object>	The tag information.
	object
Key	string	The tag key of the repository. N can be an integer from 1 to 20. The tag key cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`. The tag key cannot be an empty string.	TestKey
Value	string	The tag value of the repository. N can be an integer from 1 to 20. The tag value cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`. The tag value cannot be an empty string.	TestValue
Settings	object	The backup client settings.
ProxyHost	string	The IP address of the custom proxy server for the data plane.	192.168.11.100
MaxCpuCore	string	The number of CPU cores that are used by a single backup job. A value of 0 indicates that the number of CPU cores is not limited.	1
ProxyPort	integer	The port number of the custom proxy server for the data plane.	3128
UseHttps	string	Indicates whether data is transmitted over HTTPS on the data plane. true: Data is transmitted over HTTPS. false: Data is transmitted over HTTP.	false
ProxyPassword	string	The password for the custom proxy server for the data plane.	******
ProxyUser	string	The username for the custom proxy server for the data plane.	user
DataProxySetting	string	The proxy settings for the data plane. Valid values: DISABLE: A proxy is not used. USE_CONTROL_PROXY (default): The proxy settings are the same as the control plane. CUSTOM: Custom settings are used. The HTTP protocol is used.	USE_CONTROL_PROXY
DataNetworkType	string	The network type of the data plane. Valid values: PUBLIC: Internet VPC: VPC CLASSIC: classic network	VPC
MaxWorker	string	The number of concurrent backup jobs. A value of 0 indicates that the number of concurrent backup jobs is not limited.	1
MaxMemory	integer	The maximum memory that the client can use. Unit: bytes. This parameter is supported only for client versions 2.13.0 and later.	0
AlertOnPartialComplete	boolean	Indicates whether to generate an alert for partially completed jobs. This parameter is valid only for local file backup and ECS file backup.	false

Contoh

Respons sukses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Clients": [
    {
      "Status": "ACTIVATED",
      "BackupStatus": "PROTECTED",
      "ArchType": "amd64",
      "ClientId": "c-*********************",
      "MaxClientVersion": "2.4.5",
      "PrivateIpV4": "192.168.1.1",
      "InstanceName": "instancename",
      "CreatedTime": 1554347313,
      "LastHeartBeatTime": 1554347313,
      "ClientType": "ECS_CLIENT",
      "Hostname": "hostname",
      "InstanceId": "i-*********************",
      "Appliance": false,
      "UpdatedTime": 1554347313,
      "OsType": "linux",
      "ZoneId": "cn-hangzhou-f",
      "ClientVersion": "2.4.5",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Settings": {
        "ProxyHost": "192.168.11.100",
        "MaxCpuCore": "1",
        "ProxyPort": 3128,
        "UseHttps": "false",
        "ProxyPassword": "******",
        "ProxyUser": "user",
        "DataProxySetting": "USE_CONTROL_PROXY",
        "DataNetworkType": "VPC",
        "MaxWorker": "1",
        "MaxMemory": 0,
        "AlertOnPartialComplete": false
      }
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.