全部产品
Search
文档中心

混合云备份 HBR:CreateClients - 安装客户端

更新时间:Mar 17, 2023

调用CreateClients接口在指定实例上安装一个或多个HBR备份客户端。

接口说明

请确保在使用该接口前,已充分了解混合云备份服务的收费方式和价格。更多信息,请参见计费方式与计费项

调试

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

调试

授权信息

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

请求参数

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

备份仓库ID。

v-0001ufe******kgm
AlertSettingstring

告警设置。取值为INHERITED,表示使用与备份库一致的报警方式。

INHERITED
ClientInfostring

客户端安装信息。

[ { "instanceId": "i-bp116lr******te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q******9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux******hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
UseHttpsboolean

是否使用HTTPS传输数据。

  • true:使用HTTPS传输。
  • false:使用HTTP传输。
false
ResourceGroupIdstring

资源组ID。

rg-aekzvx7d3c4kpny

返回参数

名称类型描述示例值
object
Codestring

返回码,200表示成功。

200
Messagestring

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

successful
RequestIdstring

请求ID。

4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskIdstring

异步任务ID。可以通过调用DescribeTask获取任务结果。

t-000h9x5t02vhyksf1x7k
Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
InstanceStatusesarray

ECS实例状态。 若存在ECS实例状态不满足安装客户端的需求,且请求中InstanceIds多于1个时,通过这个字段返回错误信息。

object

ECS实例状态。 若存在ECS实例状态不满足安装客户端的需求,且请求中InstanceIds多于1个时,通过这个字段返回错误信息。

ValidInstanceboolean

ECS实例是否可以安装备份客户端。

  • true:可以安装。
  • false:不可以安装。
true
InstanceIdstring

ECS实例ID。

i-2zegp3cdu******uj9i

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
  "TaskId": "t-000h9x5t02vhyksf1x7k",
  "Success": true,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "ValidInstance": true,
        "InstanceId": "i-2zegp3cdu******uj9i"
      }
    ]
  }
}

错误码

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