DescribeClients - 查询客户端信息 - 云备份

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

接口说明

该接口目前仅适用于 SAP HANA 备份，其他数据源的备份客户端请调用 DescribeBackupClients 接口。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeClients

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VaultId	string	否	备份仓库 ID。	v-0001vk0z******xdyr
ClientId	string	否	备份客户端 ID。	c-000ed600******6b0
PageNumber	integer	否	分页页码，从 1 开始，默认值为 1。	1
PageSize	integer	否	分页大小，最小值为 1，最大值为 99，默认值为 10。	10
ClientType	string	否	备份客户端类型。取值为ECS_AGENT，表示 SAP HANA 备份客户端。	ECS_AGENT
SourceType	string	否	数据源类型，取值为 HANA，表示 SAP HANA 备份。	HANA
ClusterId	string	否	SAP HANA 实例 ID。	cl-0005ni1******2l87
ResourceGroupId	string	否	资源组 ID。	rg-acfmw6bxl7o5qyq

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	17189276-465D-5EF3-8FFD-0FF51B5A41A0
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	总记录数。	12
Clients	object
Client	array<object>	备份客户端列表。
	object	客户端信息。
Status	string	备份客户端状态。取值包括： REGISTERED：注册成功 ACTIVATED：激活成功 DEACTIVATED：激活失效 INSTALLING：安装中 INSTALL_FAILED：安装失败 NOT_INSTALLED：未安装 UPGRADING：升级中 UPGRADE_FAILED：升级失败 UNINSTALLING：卸载客户端中 UNINSTALL_FAILED：卸载客户端失败 STOPPED：客户端服务已停止 UNKNOWN：客户端失联	ACTIVATED
VaultId	string	备份仓库 ID。	v-00029mx6o******n85lg
UseHttps	boolean	是否使用 HTTPS 传输数据。 true 表示使用 HTTPS 传输。 false 表示使用 HTTP 传输。	false
NetworkType	string	网络类型，返回值包括： CLASSIC：经典网络。 VPC：专有网络。	VPC
ClientName	string	客户端名称。	client-20211224-101226
ClientId	string	备份客户端 ID。	c-00062uu******2fgj
AlertSetting	string	告警设置。取值为 INHERITED，表示使用与备份库一致的报警方式。	INHERITED
InstanceName	string	ECS 实例名称。	swh-hbr
MaxVersion	string	客户端最大版本号。	1.11.23
CreatedTime	integer	客户端创建时间。	1554347313
StatusMessage	string	状态信息。	HANA_NOT_SUPPORT
ClientType	string	备份客户端类型。取值为ECS_AGENT，表示 SAP HANA 备份客户端。	ECS_AGENT
InstanceId	string	实例 ID。	i-wz9b6wya******n8yo
UpdatedTime	integer	备份客户端更新时间。UNIX 时间，单位为秒。	1554347313
ClientVersion	string	备份客户端版本号。	1.11.16
ClusterId	string	SAP HANA 实例 ID。	cl-0008c48frr******ncpk
HeartBeatTime	integer	客户端心跳时间。UNIX 时间，单位为秒。	1554347313

示例

正常返回示例

JSON格式

{
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": {
    "Client": [
      {
        "Status": "ACTIVATED",
        "VaultId": "v-00029mx6o******n85lg",
        "UseHttps": false,
        "NetworkType": "VPC",
        "ClientName": "client-20211224-101226",
        "ClientId": "c-00062uu******2fgj",
        "AlertSetting": "INHERITED",
        "InstanceName": "swh-hbr",
        "MaxVersion": "1.11.23",
        "CreatedTime": 1554347313,
        "StatusMessage": "HANA_NOT_SUPPORT",
        "ClientType": "ECS_AGENT",
        "InstanceId": "i-wz9b6wya******n8yo",
        "UpdatedTime": 1554347313,
        "ClientVersion": "1.11.16",
        "ClusterId": "cl-0008c48frr******ncpk",
        "HeartBeatTime": 1554347313
      }
    ]
  }
}

错误码

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

变更历史

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