获取一个或者多个符合条件的备份客户端信息。
调试
您可以在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 |
| ClusterId | string | 否 | 备份集群 ID。 | cl-000ge4wa61b4d337xblq |
| ClientIds | array | 否 | 备份客户端 ID 列表。 | |
| string | 否 | 备份客户端 ID。 | c-********************* | |
| InstanceIds | array | 否 | ECS 实例 ID 列表。 | |
| string | 否 | ECS 实例 ID。 | i-********************* | |
| Tag | array<object> | 否 | 返回的标签信息。 | 33738719# |
| object | 否 | 标签信息。 | ||
| Key | string | 否 | 仓库的标签键。N 的取值范围：1~20。
| TestKey |
| Value | string | 否 | 仓库的标签值。N 的取值范围：1~20。
| TestValue |
| CrossAccountType | string | 否 | 跨账号备份类型。支持：
| CROSS_ACCOUNT |
| CrossAccountUserId | long | 否 | 用于跨账号备份功能中的原账号 ID。 | 129374672382xxxx |
| CrossAccountRoleName | string | 否 | 用于跨账号备份的原账号 RAM 中创建的角色名。 | hbrcrossrole |
返回参数
示例
正常返回示例
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-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |