CreateClients_云备份 Cloud Backup_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为600/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hbr:CreateClients
Create
全部资源
*

请求参数

字段名称字段详情
VaultIdstring

备份仓库 ID。

示例值:v-0001ufe******kgm参考取值来源:
    CreateVault
    DescribeVaults
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 传输数据。展开详情

示例值:false
ResourceGroupIdstring

资源组 ID。

示例值:rg-aekzvx7d3c4kpny
CrossAccountTypestring

跨账号备份类型。支持:展开详情

示例值:CROSS_ACCOUNT
CrossAccountUserIdinteger<int64>

被当前账号管理的跨账号备份的原账号 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:158975xxxxx4625参考取值来源:
    DescribeCrossAccounts
CrossAccountRoleNamestring

被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。

示例值:hbrcrossrole参考取值来源:
    DescribeCrossAccounts

返回参数

字段名称字段详情
Codestring

返回码,200 表示成功。

示例值:200
Messagestring

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

示例值:successful
RequestIdstring

请求 ID。

示例值:4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskIdstring

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

示例值:t-000h9x5t02vhyksf1x7k
Successboolean

请求是否成功。展开详情

示例值:true
InstanceStatusesobject

返回示例

变更历史

变更时间变更内容概要操作
2024-05-22
新增请求参数CrossAccountType
新增请求参数CrossAccountUserId
新增请求参数CrossAccountRoleName
2024-02-23
删除返回参数

相关示例