AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云备份 开发参考 API参考 API目录 备份客户端 DescribeBackupClients - 获取备份客户端信息

DescribeBackupClients - 获取备份客户端信息

更新时间：
产品详情
我的收藏

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeBackupClients

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
PageNumber

integer

否

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

1
PageSize

integer

否

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

10
ClientType

string

是

备份客户端类型。取值：

  • ECS_CLIENT，表示 ECS 文件备份客户端。

  • CONTAINER_CLIENT，表示容器备份客户端。

  • LOCAL_CLIENT，表示本地 NAS 备份/CPFS 备份/归档/数据同步客户端。

枚举值：

  • CONTAINER_CLIENT :

    CONTAINER_CLIENT

  • LOCAL_CLIENT :

    LOCAL_CLIENT

  • ECS_CLIENT :

    ECS_CLIENT

ECS_CLIENT
ClusterId

string

否

备份集群 ID。

cl-000ge4wa61b4d337xblq
ClientIds

array

否

备份客户端 ID 列表。

["c-*********************"]

string

否

备份客户端 ID。

c-*********************
InstanceIds

array

否

ECS 实例 ID 列表。

["i-*********************"]

string

否

ECS 实例 ID。

i-*********************
Tag

array<object>

否

返回的标签信息。

33738719#

object

否

标签信息。

Key

string

否

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

  • 不支持以aliyun、acs:开头。

  • 不允许包含http://和https:// 。

  • 不允许为空字符串。

TestKey
Value

string

否

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

  • 不支持以aliyun、acs:开头。

  • 不允许包含http://和https:// 。

  • 不允许为空字符串。

TestValue
CrossAccountType

string

否

跨账号备份类型。支持：

  • SELF_ACCOUNT：本账号备份

  • CROSS_ACCOUNT：跨账号备份

CROSS_ACCOUNT
CrossAccountUserId

integer

否

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

129374672382xxxx
CrossAccountRoleName

string

否

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

hbrcrossrole
Filters

array<object>

否

查询过滤器。

object

否

查询过滤器。

Key

string

否

查询过滤器中的键值。

InstanceId
Values

array

否

查询过滤器中的待匹配的值。

string

否

查询过滤器中的待匹配的值。

i-*********************

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

boolean

请求是否成功。

  • true 表示成功。

  • false 表示失败。

true
Code

string

返回码。200 表示成功。

200
Message

string

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

successful
PageNumber

integer

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

1
PageSize

integer

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

10
TotalCount

integer

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

8
Clients

array<object>

备份客户端列表。

{'Client': []}

object

Status

string

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

  • REGISTERED：注册成功

  • ACTIVATED：激活成功

  • DEACTIVATED：激活失效

  • INSTALLING：安装中

  • INSTALL_FAILED：安装失败

  • NOT_INSTALLED：未安装

  • UPGRADING：升级中

  • UPGRADE_FAILED：升级失败

  • UNINSTALLING：卸载客户端中

  • UNINSTALL_FAILED：卸载客户端失败

  • STOPPED：客户端服务已停止

  • UNKNOWN：客户端失联

ACTIVATED
BackupStatus

string

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

  • UNPROTECTED：服务器未受保护

  • PROTECTED：服务器已受保护

PROTECTED
ArchType

string

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

  • amd64

  • 386

amd64
ClientId

string

备份客户端 ID。

c-*********************
MaxClientVersion

string

最新备份客户端版本号。

2.4.5
PrivateIpV4

string

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

192.168.1.1
InstanceName

string

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

instancename
CreatedTime

integer

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

1554347313
LastHeartBeatTime

integer

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

1554347313
ClientType

string

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

ECS_CLIENT
Hostname

string

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

hostname
InstanceId

string

实例 ID。

  • 当客户端类型为 ECS 文件备份客户端时，表示 ECS 实例 ID。

  • 当客户端类型为本地文件备份客户端时，表示根据系统信息生成的硬件指纹。

i-*********************
Appliance

boolean

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

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

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

false
UpdatedTime

integer

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

1554347313
OsType

string

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

  • windows

  • linux

linux
ZoneId

string

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

cn-hangzhou-f
ClientVersion

string

备份客户端版本号。

2.4.5
Tags

array<object>

标签信息。

object

Key

string

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

  • 不支持以aliyun、acs:开头。

  • 不允许包含http://和https:// 。

  • 不允许为空字符串。

TestKey
Value

string

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

  • 不支持以aliyun、acs:开头。

  • 不允许包含http://和https:// 。

  • 不允许为空字符串。

TestValue
Settings

object

备份客户端配置信息。

ProxyHost

string

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

192.168.11.100
MaxCpuCore

string

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

1
ProxyPort

integer

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

3128
UseHttps

string

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

  • true 表示使用 HTTPS 传输。

  • false 表示使用 HTTP 传输。

false
ProxyPassword

string

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

******
ProxyUser

string

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

user
DataProxySetting

string

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

  • DISABLE：不使用代理

  • USE_CONTROL_PROXY（默认）：与控制面配置相同

  • CUSTOM：自定义配置（HTTP 协议）

USE_CONTROL_PROXY
DataNetworkType

string

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

  • PUBLIC：公网

  • VPC：VPC 网络

  • CLASSIC：经典网络

VPC
MaxWorker

string

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

1
MaxMemory

integer

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

0
AlertOnPartialComplete

boolean

是否针对部分完成任务告警，仅针对本地文件备份和 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
      }
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：UpdateClientSettings - 更新客户端配置下一篇：InstallBackupClients - 安装备份客户端