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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackupClients

The operation that you want to perform. Set the value to DescribeBackupClients.

ClientType String Yes ECS_CLIENT

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

PageNumber Integer No 1

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

PageSize Integer No 10

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

ClientIds Json No ["c-*********************"]

The IDs of backup clients.

InstanceIds Json No ["i-*********************"]

The IDs of ECS instances.

Tag.N.Key String No TestKey

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.
Tag.N.Value String No TestValue

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.

Response parameters

Parameter Type Example Description
Clients Array of Client

The backup clients.

Appliance Boolean false

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.
ArchType String amd64

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
BackupStatus String PROTECTED

The protection status of the backup client. Valid values:

  • UNPROTECTED: The backup client is not protected.
  • PROTECTED: The backup client is protected.
ClientId String c-*********************

The ID of the client.

ClientType String ECS_CLIENT

The type of the backup client. Valid value: ECS_CLIENT: backup clients for ECS.

ClientVersion String 2.4.5

The version number of the backup client.

CreatedTime Long 1554347313

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

Hostname String hostname

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

InstanceId String i-*********************

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.
InstanceName String instancename

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

LastHeartBeatTime Long 1554347313

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

MaxClientVersion String 2.4.5

The version number of the latest backup client.

OsType String linux

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
PrivateIpV4 String 192.168.1.1

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.

Settings Struct

The settings of the backup client.

DataNetworkType String VPC

The network type of the backup client. Valid values:

  • PUBLIC: public network
  • VPC: VPC
  • CLASSIC: classic network
DataProxySetting String USE_CONTROL_PROXY

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.
MaxCpuCore String 1

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

MaxWorker String 1

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

ProxyHost String 192.168.11.100

The custom IP address of the proxy server.

ProxyPassword String ******

The custom password of the proxy server.

ProxyPort Integer 3128

The custom port number of the proxy server.

ProxyUser String user

The custom username of the proxy server.

UseHttps String false

Indicates whether data is transmitted over HTTPS.

  • true: Data is transmitted over HTTPS.
  • false: Data is transmitted over HTTP.
Status String ACTIVATED

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.
Tags Array of Tag

The information about tags.

Key String TestKey

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.
Value String TestValue

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.
UpdatedTime Long 1554347313

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

ZoneId String cn-hangzhou-f

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

Code String 200

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

Message String successful

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.

PageNumber Integer 1

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

PageSize Integer 10

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

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
TotalCount Long 8

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

Examples

Sample requests

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

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.