文档

DescribeBackupClients - 获取备份客户端信息

更新时间:

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

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

1
PageSizeinteger

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

10
ClientTypestring

备份客户端类型。取值:

  • ECS_CLIENT,表示 ECS 文件备份客户端。
  • CONTAINER_CLIENT,表示容器备份客户端。
ECS_CLIENT
ClusterIdstring

备份集群 ID。

cl-000ge4wa61b4d337xblq
ClientIdsarray

备份客户端 ID 列表。

string

备份客户端 ID。

c-*********************
InstanceIdsarray

ECS 实例 ID 列表。

string

ECS 实例 ID。

i-*********************
Tagobject []

返回的标签信息。

33738719#
Keystring

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

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

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

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

跨账号备份类型。支持:

  • SELF_ACCOUNT:本账号备份
  • CROSS_ACCOUNT:跨账号备份
CROSS_ACCOUNT
CrossAccountUserIdlong

用于跨账号备份功能中的原账号 ID。

129374672382xxxx
CrossAccountRoleNamestring

用于跨账号备份的原账号 RAM 中创建的角色名。

hbrcrossrole

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

请求是否成功。

  • true 表示成功。
  • false 表示失败。
true
Codestring

返回码。200 表示成功。

200
Messagestring

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

successful
PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountlong

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

8
Clientsobject []

备份客户端列表。

{'Client': []}
Statusstring

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

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

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

  • UNPROTECTED:服务器未受保护
  • PROTECTED:服务器已受保护
PROTECTED
ArchTypestring

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

  • amd64
  • 386
amd64
ClientIdstring

备份客户端 ID。

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

最新备份客户端版本号。

2.4.5
PrivateIpV4string

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

192.168.1.1
InstanceNamestring

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

instancename
CreatedTimelong

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

1554347313
LastHeartBeatTimelong

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

1554347313
ClientTypestring

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

ECS_CLIENT
Hostnamestring

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

hostname
InstanceIdstring

实例 ID。

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

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

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

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

1554347313
OsTypestring

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

  • windows
  • linux
linux
ZoneIdstring

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

cn-hangzhou-f
ClientVersionstring

备份客户端版本号。

2.4.5
Tagsobject []

标签信息。

Keystring

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

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

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

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

备份客户端配置信息。

ProxyHoststring

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

192.168.11.100
MaxCpuCorestring

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

1
ProxyPortinteger

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

3128
UseHttpsstring

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

  • true 表示使用 HTTPS 传输。
  • false 表示使用 HTTP 传输。
false
ProxyPasswordstring

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

******
ProxyUserstring

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

user
DataProxySettingstring

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

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

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

  • PUBLIC:公网
  • VPC:VPC 网络
  • CLASSIC:经典网络
VPC
MaxWorkerstring

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

1
MaxMemorylong

客户端能够使用的最大内存,单位是 bytes。仅支持 2.13.0 及以上版本。

0
AlertOnPartialCompleteboolean

是否针对部分完成任务告警,仅针对本地文件备份和 ECS 文件备份生效。

false

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-31OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更