获取一个或多个符合条件的备份客户端。
接口说明
该接口目前仅适用于 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 |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史