DescribeBackupClients - Cloud Backup - Alibaba Cloud Documentation Center

Queries the information about one or more HBR clients that meet the specified conditions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hbr:DescribeBackupClients	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
ClientType	string	Yes	The type of the HBR client. Valid values: ECS_CLIENT: HBR client for Elastic Compute Service (ECS) file backup CONTAINER_CLIENT: HBR client for container backup Enumeration Value: CONTAINER_CLIENT: CONTAINER_CLIENT. LOCAL_CLIENT: LOCAL_CLIENT. ECS_CLIENT: ECS_CLIENT.	ECS_CLIENT
ClusterId	string	No	The ID of the cluster for the backup.	cl-000ge4wa61b4d337xblq
ClientIds	array	No	The IDs of HBR clients.
	string	No	The ID of the HBR client.	c-*********************
InstanceIds	array	No	The IDs of ECS instances.
	string	No	The ID of the ECS instance.	i-*********************
Tag	array<object>	No	The tags.	33738719#
	object	No	The tag information.
Key	string	No	The tag key of the backup vault. Valid values of N: 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 backup vault. Valid values of N: 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	Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	long	No	The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	129374672382xxxx
CrossAccountRoleName	string	No	The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	hbrcrossrole

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
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
PageNumber	integer	The page number of the returned page. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries returned on each page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	long	The total number of returned HBR clients that meet the specified conditions.	8
Clients	array<object>	The queried backup clients.	{'Client': []}
Client	object
Status	string	The status of the 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
BackupStatus	string	The protection status of the backup client. Valid values: UNPROTECTED: The backup client is not protected. PROTECTED: The backup client is protected.	PROTECTED
ArchType	string	This parameter is valid only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the system architecture where the backup client resides. Valid values: amd64 386	amd64
ClientId	string	The ID of the backup client.	c-*********************
MaxClientVersion	string	The latest version number of the backup client.	2.4.5
PrivateIpV4	string	This parameter is valid only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the internal IP address of the ECS instance.	192.168.1.1
InstanceName	string	This parameter is valid only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the name of the ECS instance.	instancename
CreatedTime	long	The time when the backup client was created. The value is a UNIX timestamp. Unit: seconds.	1554347313
LastHeartBeatTime	long	The last heartbeat time of the backup client. The value is a UNIX timestamp. Unit: seconds.	1554347313
ClientType	string	The type of the backup client. Valid value: ECS_CLIENT, which indicates a client for ECS file backup.	ECS_CLIENT
Hostname	string	The hostname of the backup client.	hostname
InstanceId	string	The instance ID. If the client is used to back up ECS files, this parameter indicates the ID of an ECS instance. If the client is used to back up on-premises files, this parameter indicates the hardware fingerprint that is generated based on the system information.	i-*********************
Appliance	boolean	Indicates whether the client is installed on an all-in-one PC that integrates hardware and monitoring program. Valid values: true: The client is installed on an all-in-one PC that integrates hardware and monitoring program. false: The client is not installed on an all-in-one PC that integrates hardware and monitoring program.	false
UpdatedTime	long	The time when the backup client was updated. The value is a UNIX timestamp. Unit: seconds.	1554347313
OsType	string	This parameter is valid only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the operating system type of the backup client. Valid values: windows linux	linux
ZoneId	string	This parameter is valid only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the zone of the backup client.	cn-hangzhou-f
ClientVersion	string	The version number of the backup client.	2.4.5
Tags	array<object>	The tag information.
Tag	object
Key	string	The tag key of the backup vault. Valid values of N: 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 backup vault. Valid values of N: 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 configuration information of the backup client.
ProxyHost	string	The custom host IP address of the proxy server on the data plane.	192.168.11.100
MaxCpuCore	string	The number of CPU cores used by a single backup job. The value 0 indicates that the number is unlimited.	1
ProxyPort	integer	The custom host port of the proxy server on the data plane.	3128
UseHttps	string	Indicates whether data on the data plane is transmitted over HTTPS. Valid values: true: Data is transmitted over HTTPS. false: Data is transmitted over HTTP.	false
ProxyPassword	string	The custom password of the proxy server on the data plane.	******
ProxyUser	string	The custom username of the proxy server on the data plane.	user
DataProxySetting	string	The proxy configuration on the data plane. Valid values: DISABLE: The proxy is not used. USE_CONTROL_PROXY (default): The configuration is the same as that on the control plane. CUSTOM: The configuration is customized (HTTP).	USE_CONTROL_PROXY
DataNetworkType	string	The type of the endpoint on the data plane. Valid values: PUBLIC: Internet VPC: virtual private cloud (VPC) CLASSIC: classic network	VPC
MaxWorker	string	The number of concurrent backup jobs. The value 0 indicates that the number is unlimited.	1
MaxMemory	long	The maximum memory that can be used by the client. Unit: bytes. Only V2.13.0 and later are supported.	0
AlertOnPartialComplete	boolean	Indicates whether alerts are generated for partially completed jobs. This parameter is valid only for on-premises file backup and ECS file backup.	false

Examples

Sample success responses

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
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-08	The response structure of the API has changed	View Change Details
2023-07-31	The response structure of the API has changed	View Change Details