调用DescribeBackupClients获取一个或者多个符合条件的备份客户端信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackupClients

系统规定参数。取值:DescribeBackupClients

ClientType String ECS_CLIENT

备份客户端类型。取值为ECS_CLIENT,表示ECS文件备份客户端。

PageNumber Integer 1

分页页码,从1开始,默认值为1。

PageSize Integer 10

分页大小,最小值为1,最大值为99,默认值为10。

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

备份客户端ID列表。

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

ECS实例ID列表。

Tag.N.Key String TestKey

仓库的标签键。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
Tag.N.Value String TestValue

仓库的标签值。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。

返回数据

名称 类型 示例值 描述
Clients Array of Client

备份客户端列表。

Appliance Boolean false

是否是硬件监控一体机客户端。

  • true表示是硬件监控一体机客户端。
  • false表示不是硬件监控一体机客户端。
ArchType String amd64

仅当ClientType取值为ECS_CLIENT时,该参数有效。表示备份客户端所在的系统架构。取值范围:

  • amd64
  • 386
BackupStatus String PROTECTED

备份客户端受保护状态。取值范围:

  • UNPROTECTED:服务器未受保护
  • PROTECTED:服务器已受保护
ClientId String c-*********************

备份客户端ID。

ClientType String ECS_CLIENT

备份客户端类型。取值为ECS_CLIENT,表示ECS文件备份客户端。

ClientVersion String 2.4.5

备份客户端版本号。

CreatedTime Long 1554347313

备份客户端创建时间。UNIX时间,单位为秒。

Hostname String hostname

备份客户端所在的主机名。

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

实例ID。

  • 当客户端类型为ECS文件备份客户端时,表示ECS实例ID。
  • 当客户端类型为本地文件备份客户端时,表示根据系统信息生成的硬件指纹。
InstanceName String instancename

仅当ClientType取值为ECS_CLIENT时,该参数有效。表示ECS实例名称。

LastHeartBeatTime Long 1554347313

备份客户端最后一次心跳时间。UNIX时间,单位为秒。

MaxClientVersion String 2.4.5

最新备份客户端版本号。

OsType String linux

仅当ClientType取值为ECS_CLIENT时,该参数有效。表示客户端系统类型。取值范围:

  • windows
  • linux
PrivateIpV4 String 192.168.1.1

仅当ClientType取值为ECS_CLIENT时,该参数有效。表示ECS实例内网IP地址。

Settings Struct

备份客户端配置信息。

DataNetworkType String VPC

数据面数据接入点类型。取值范围:

  • PUBLIC:公网
  • VPC:VPC网络
  • CLASSIC:经典网络
DataProxySetting String USE_CONTROL_PROXY

数据面代理设置。取值范围:

  • DISABLE:不使用代理
  • USE_CONTROL_PROXY (默认):与控制面配置相同
  • CUSTOM:自定义配置(HTTP协议)
MaxCpuCore String 1

单个备份任务使用的CPU核数,0表示不限制。

MaxWorker String 1

单个备份任务并发工作数量,0表示不限制。

ProxyHost String 192.168.11.100

自定义数据面代理服务器主机IP地址。

ProxyPassword String ******

自定义数据面代理服务器密码。

ProxyPort Integer 3128

自定义数据面代理服务器主机端口。

ProxyUser String user

自定义数据面代理服务器用户名。

UseHttps String false

是否使用HTTPS传输数据面数据。

  • true表示使用HTTPS传输。
  • false表示使用HTTP传输。
Status String ACTIVATED

备份客户端状态。取值范围:

  • REGISTERED:注册成功
  • ACTIVATED:激活成功
  • DEACTIVATED:激活失效
  • INSTALLING:安装中
  • INSTALL_FAILED:安装失败
  • NOT_INSTALLED:未安装
  • UPGRADING:升级中
  • UPGRADE_FAILED:升级失败
  • UNINSTALLING:卸载客户端中
  • UNINSTALL_FAILED:卸载客户端失败
  • STOPPED:客户端服务已停止
  • UNKNOWN:客户端失联
Tags Array of Tag

标签信息。

Key String TestKey

仓库的标签键。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
Value String TestValue

仓库的标签值。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
UpdatedTime Long 1554347313

备份客户端更新时间。UNIX时间,单位为秒。

ZoneId String cn-hangzhou-f

仅当ClientType取值为ECS_CLIENT时,该参数有效。表示地域。

Code String 200

返回码。200表示成功。

Message String successful

返回信息描述,成功一般返回successful,错误时会返回相应错误信息。

PageNumber Integer 1

分页页码,从1开始,默认值为1。

PageSize Integer 10

分页大小,最小值为1,最大值为99,默认值为10。

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

请求ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
TotalCount Long 8

查询到的符合条件的备份客户端总数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupClients
&ClientType=ECS_CLIENT
&<公共请求参数>

正常返回示例

XML格式

<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格式

{
    "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
}

错误码

访问错误中心查看更多错误码。