CreateClients - 安装客户端 - 云备份

在指定实例上安装一个或多个HBR备份客户端。

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hbr:CreateClients

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VaultId	string	是	备份仓库 ID。	v-0001ufe******kgm
AlertSetting	string	否	告警设置。取值为 INHERITED，表示使用与备份库一致的报警方式。	INHERITED
ClientInfo	string	否	客户端安装信息。	[ { "instanceId": "i-bp116lr****te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q**9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux****hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
UseHttps	boolean	否	是否使用 HTTPS 传输数据。 true：使用 HTTPS 传输。 false：使用 HTTP 传输。	false
ResourceGroupId	string	否	资源组 ID。	rg-aekzvx7d3c4kpny
CrossAccountType	string	否	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	integer	否	被当前账号管理的跨账号备份的原账号 ID。	158975xxxxx4625
CrossAccountRoleName	string	否	被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。	hbrcrossrole

返回参数

名称	类型	描述	示例值
	object
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
RequestId	string	请求 ID。	4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskId	string	异步任务 ID。可以通过调用 DescribeTask 获取任务结果。	t-000h9x5t02vhyksf1x7k
Success	boolean	请求是否成功。 true：成功 false：失败	true
InstanceStatuses	object
InstanceStatus	array<object>	ECS 实例状态。若存在 ECS 实例状态不满足安装客户端的需求，且请求中 InstanceIds 多于 1 个时，通过这个字段返回错误信息。
	object	ECS 实例状态。若存在 ECS 实例状态不满足安装客户端的需求，且请求中 InstanceIds 多于 1 个时，通过这个字段返回错误信息。
ValidInstance	boolean	ECS 实例是否可以安装备份客户端。 true：可以安装。 false：不可以安装。	true
InstanceId	string	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"
      }
    ]
  }
}

错误码

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

变更历史

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