All Products
Search
Document Center

Hybrid Backup Recovery:DescribeBackupClients

Last Updated:Nov 14, 2022

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

10
ClientTypestringYes

The type of the backup client. Valid value: ECS_CLIENT: backup clients for Elastic Compute Service (ECS).

ECS_CLIENT
ClientIdsobjectNo

The IDs of backup clients.

InstanceIdsobjectNo

The IDs of ECS instances.

TagarrayNo

The information about tags.

objectNo

The information about tags.

KeystringNo

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
ValuestringNo

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

Response parameters

ParameterTypeDescriptionExample
object

The reponse body.

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
true
Codestring

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

200
Messagestring

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
PageNumberinteger

The page number of the returned page. Pages start from 1. Default value: 1.

1
PageSizeinteger

The number of entries returned per page. Valid values: 1 to 99. Default value: 10.

10
TotalCountlong

The total number of returned backup clients that meet the specified conditions.

8
Clientsarray

The backup clients.

object

The backup clients.

Statusstring

The status of the backup client. Valid values:

  • REGISTERED: The backup client is registered.
  • ACTIVATED: The backup client is enabled.
  • DEACTIVATED: The backup client fails to be enabled.
  • 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
BackupStatusstring

The protection status of the backup client. Valid values:

  • UNPROTECTED: The backup client is not protected.
  • PROTECTED: The backup client is protected.
PROTECTED
ArchTypestring

This parameter is returned only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the system architecture of the ECS instance on which the backup client resides. Valid values:

  • amd64
  • 386
amd64
ClientIdstring

The ID of the client.

c-*********************
MaxClientVersionstring

The version number of the latest backup client.

2.4.5
PrivateIpV4string

This parameter is returned 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
InstanceNamestring

This parameter is returned only if the ClientType parameter is set to ECS_CLIENT. The name of the ECS instance.

instancename
CreatedTimelong

The time when the backup client was created. The time follows the UNIX time format. Unit: seconds.

1554347313
LastHeartBeatTimelong

The time when the last heartbeat of the backup client was received. The time follows the UNIX time format. Unit: seconds.

1554347313
ClientTypestring

The type of the backup client. Valid value: ECS_CLIENT: backup clients for Elastic Compute Service (ECS).

ECS_CLIENT
Hostnamestring

The name of the host on which the backup client resides.

hostname
InstanceIdstring

The ID of the instance.

  • If the type of the backup client is ECS, the value of this parameter indicates the ID of an ECS instance.
  • If the type of the backup client is on-premises, the value of this parameter indicates the hardware fingerprint that is generated based on the system information.
i-*********************
Applianceboolean

Indicates whether the backup client is a an integrated hardware monitoring client.

  • true: the backup client is an integrated hardware monitoring client.
  • false: the backup client is not an integrated hardware monitoring client.
false
UpdatedTimelong

The time when the backup client was updated. The time follows the UNIX time format. Unit: seconds.

1554347313
OsTypestring

This parameter is returned only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the system type of the backup client. Valid values:

  • windows
  • linux
linux
ZoneIdstring

This parameter is returned only if the ClientType parameter is set to ECS_CLIENT. This parameter indicates the region where the backup client resides.

cn-hangzhou-f
ClientVersionstring

The version number of the backup client.

2.4.5
Tagsarray

The information about tags.

object

The information about tags.

Keystring

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
Valuestring

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
Settingsobject

The settings of the backup client.

ProxyHoststring

The custom IP address of the proxy server.

192.168.11.100
MaxCpuCorestring

The number of CPU cores that can be used by a single backup job. A value of 0 indicates no limits.

1
ProxyPortinteger

The custom port number of the proxy server.

3128
UseHttpsstring

Indicates whether data is transmitted over HTTPS.

  • true: Data is transmitted over HTTPS.
  • false: Data is transmitted over HTTP.
false
ProxyPasswordstring

The custom password of the proxy server.

******
ProxyUserstring

The custom username of the proxy server.

user
DataProxySettingstring

The proxy setting of the backup client. Valid values:

  • DISABLE: No proxy is configured.
  • USE_CONTROL_PROXY: The proxy settings are the same as the settings that are preconfigured in the system. Default value: USE_CONTROL_PROXY.
  • CUSTOM: Custom HTTP proxy settings are configured.
USE_CONTROL_PROXY
DataNetworkTypestring

The network type of the backup client. Valid values:

  • PUBLIC: public network
  • VPC: VPC
  • CLASSIC: classic network
VPC
MaxWorkerstring

The number of concurrent tasks that can be included in a backup job. A value of 0 indicates no limits.

1

Example

Request example

http(s)://[Endpoint]/?Action=DescribeBackupClients
&ClientType=ECS_CLIENT
&<Common request parameters>

Normal return example

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": true,
      "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"
      }
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.