
# CLI命令参考
#### 文件应用备份
| API名称   | 命令                         | 描述                              | 操作                                                                                       |
|:---|:---|:---|:---|
| 新增备份路径  | hcloud CBR AddAgentPath    | 对客户端新增备份路径，新增的路径不会校验是否存在。       | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=AddAgentPath)    |
| 查询指定客户端 | hcloud CBR ShowAgent       | 查询指定客户端                         | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowAgent)       |
| 修改客户端   | hcloud CBR UpdateAgent     | 修改客户端状态                         | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdateAgent)     |
| 移除客户端   | hcloud CBR UnregisterAgent | 移除客户端，移除客户端时将会删除该客户端所有备份，请谨慎操作。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UnregisterAgent) |
| 查询客户端列表 | hcloud CBR ListAgent       | 查询客户端列表                         | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListAgent)       |
| 注册客户端   | hcloud CBR RegisterAgent   | 注册客户端，安装时候由Agent调用，无需手动注册。      | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=RegisterAgent)   |
| 移除备份路径  | hcloud CBR RemoveAgentPath | 移除已添加的文件备份路径。                   | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=RemoveAgentPath) |
   
#### 任务
| API名称  | 命令                    | 描述           | 操作                                                                                  |
|:---|:---|:---|:---|
| 查询单个任务 | hcloud CBR ShowOpLog  | 根据指定任务ID查询任务 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowOpLog)  |
| 查询任务列表 | hcloud CBR ListOpLogs | 查询任务列表       | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListOpLogs) |
   
#### 备份共享
| API名称    | 命令                            | 描述                                               | 操作                                                                                          |
|:---|:---|:---|:---|
| 获取备份成员列表 | hcloud CBR ShowMembersDetail  | 获取备份共享成员的列表信息                                    | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowMembersDetail)  |
| 添加备份成员   | hcloud CBR AddMember          | 添加备份可共享的成员，只有云服务器备份可以添加备份共享成员，且仅支持在同一区域的不同用户间共享。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=AddMember)          |
| 获取备份成员详情 | hcloud CBR ShowMemberDetail   | 获取备份成员的详情                                        | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowMemberDetail)   |
| 更新备份成员状态 | hcloud CBR UpdateMemberStatus | 更新备份共享成员的状态，需要接收方执行此API。                         | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdateMemberStatus) |
| 删除指定备份成员 | hcloud CBR DeleteMember       | 删除指定的备份共享成员                                      | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DeleteMember)       |
   
#### 还原点
| API名称   | 命令                          | 描述               | 操作                                                                                        |
|:---|:---|:---|:---|
| 同步备份还原点 | hcloud CBR ImportCheckpoint | 针对vault同步备份副本    | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ImportCheckpoint) |
| 查询备份还原点 | hcloud CBR ShowCheckpoint   | 根据还原点ID查询指定还原点   | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowCheckpoint)   |
| 复制备份还原点 | hcloud CBR CopyCheckpoint   | 执行复制             | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CopyCheckpoint)   |
| 创建备份还原点 | hcloud CBR CreateCheckpoint | 对存储库执行备份，生成备份还原点 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CreateCheckpoint) |
   
#### 存储库
| API名称       | 命令                                 | 描述                               | 操作                                                                                               |
|:---|:---|:---|:---|
| 查询存储库列表     | hcloud CBR ListVault               | 查询存储库列表                          | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListVault)               |
| 创建存储库       | hcloud CBR CreateVault             | 创建存储库                            | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CreateVault)             |
| 查询指定存储库     | hcloud CBR ShowVault               | 根据ID查询指定存储库                      | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowVault)               |
| 修改存储库       | hcloud CBR UpdateVault             | 根据存储库ID修改存储库                     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdateVault)             |
| 删除存储库       | hcloud CBR DeleteVault             | 删除存储库。若删除储存库，将一并删除存储库中的所有备份。     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DeleteVault)             |
| 移除资源        | hcloud CBR RemoveVaultResource     | 移除存储库中的资源，若移除资源，将一并删除该资源在保管库中的备份 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=RemoveVaultResource)     |
| 添加资源        | hcloud CBR AddVaultResource        | 存储库添加资源                          | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=AddVaultResource)        |
| 设置存储库策略     | hcloud CBR AssociateVaultPolicy    | 存储库设置策略                          | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=AssociateVaultPolicy)    |
| 解除存储库策略     | hcloud CBR DisassociateVaultPolicy | 存储库解除策略                          | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DisassociateVaultPolicy) |
| 查询其他区域存储库列表 | hcloud CBR ListExternalVault       | 查询其他区域的存储库列表                     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListExternalVault)       |
| 迁移资源        | hcloud CBR MigrateVaultResource    | 支持资源迁移到另一个存储库，不删除备份。             | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=MigrateVaultResource)    |
| 批量修改存储库     | hcloud CBR BatchUpdateVault        | 批量修改项目下所有存储库                     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=BatchUpdateVault)        |
| 设置存储库资源     | hcloud CBR SetVaultResource        | 设置存储库资源是否自动备份                    | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=SetVaultResource)        |
| 创建包周期存储库    | hcloud CBR CreatePostPaidVault     | 创建包周期存储库                         | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CreatePostPaidVault)     |
| 存储库容量总览     | hcloud CBR ShowSummary             | 查询项目下所有存储库的总容量和总使用量              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowSummary)             |
   
#### 备份
| API名称   | 命令                       | 描述                | 操作                                                                                     |
|:---|:---|:---|:---|
| 同步备份    | hcloud CBR ImportBackup  | 同步线下混合云VMware备份副本 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ImportBackup)  |
| 查询指定备份  | hcloud CBR ShowBackup    | 根据指定id查询单个副本。     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowBackup)    |
| 更新备份    | hcloud CBR UpdateBackup  | 根据备份id更改备份        | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdateBackup)  |
| 删除备份    | hcloud CBR DeleteBackup  | 删除单个备份。           | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DeleteBackup)  |
| 查询所有备份  | hcloud CBR ListBackups   | 查询所有副本            | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListBackups)   |
| 复制备份    | hcloud CBR CopyBackup    | 跨区域复制备份。          | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CopyBackup)    |
| 备份恢复    | hcloud CBR RestoreBackup | 恢复备份数据            | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=RestoreBackup) |
| 查询备份元数据 | hcloud CBR ShowMetadata  | 查询备份时资源的元数据       | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowMetadata)  |
   
#### 策略
| API名称  | 命令                      | 描述                  | 操作                                                                                    |
|:---|:---|:---|:---|
| 查询策略列表 | hcloud CBR ListPolicies | 查询策略列表              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListPolicies) |
| 创建策略   | hcloud CBR CreatePolicy | 创建策略，策略分为备份策略和复制策略。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CreatePolicy) |
| 查询单个策略 | hcloud CBR ShowPolicy   | 查询单个策略              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowPolicy)   |
| 修改策略   | hcloud CBR UpdatePolicy | 修改策略                | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdatePolicy) |
| 删除策略   | hcloud CBR DeletePolicy | 删除策略                | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DeletePolicy) |
   
#### 可保护性
| API名称     | 命令                                     | 描述             | 操作                                                                                                   |
|:---|:---|:---|:---|
| 查询可保护资源   | hcloud CBR ListProtectable             | 查询可保护性资源列表     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListProtectable)             |
| 查询agent状态 | hcloud CBR CheckAgent                  | 检查应用一致性Agent状态 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CheckAgent)                  |
| 查询指定可保护资源 | hcloud CBR ShowProtectable             | 根据ID查询可保护性资源   | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowProtectable)             |
| 查询复制能力    | hcloud CBR ShowReplicationCapabilities | 查询本区域的复制能力     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowReplicationCapabilities) |
   
#### 项目
| API名称     | 命令                            | 描述                                         | 操作                                                                                          |
|:---|:---|:---|:---|
| 查询租户的项目信息 | hcloud CBR ListProjects       | 查询租户的企业项目信息                                | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListProjects)       |
| 查询租户项目列表  | hcloud CBR ListDomainProjects | 根据指定租户名称查询项目列表。                            | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListDomainProjects) |
| 查询租户信息    | hcloud CBR ShowDomain         | 由控制台调用的内部接口，用于仅在查询共享备份时获取源project_id的域名信息。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowDomain)         |
| 查询迁移      | hcloud CBR ShowMigrateStatus  | 查询迁移结果                                     | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowMigrateStatus)  |
| 租户迁移      | hcloud CBR MigrateDomain      | 将CSBS/VBS资源迁移到CBR。                         | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=MigrateDomain)      |
   
#### 标签
| API名称         | 命令                                       | 描述                                       | 操作                                                                                                     |
|:---|:---|:---|:---|
| 查询存储库资源实例     | hcloud CBR ShowVaultResourceInstances    | 使用标签过滤实例                                 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowVaultResourceInstances)    |
| 批量添加删除存储库资源标签 | hcloud CBR BatchCreateAndDeleteVaultTags | 为指定实例批量添加或删除标签                           | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=BatchCreateAndDeleteVaultTags) |
| 查询存储库资源标签     | hcloud CBR ShowVaultTag                  | 查询指定实例的标签信息                              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowVaultTag)                  |
| 添加存储库资源标签     | hcloud CBR CreateVaultTags               | 一个资源上最多有10个标签。                           | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CreateVaultTags)               |
| 删除存储库资源标签     | hcloud CBR DeleteVaultTag                | 幂等接口：删除时，如果删除的标签不存在，返回404。Key不能为空或者空字符串。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DeleteVaultTag)                |
| 查询存储库项目标签     | hcloud CBR ShowVaultProjectTag           | 查询租户在指定Region和实例类型的所有标签集合                | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowVaultProjectTag)           |
   
#### 计量
| API名称  | 命令                          | 描述     | 操作                                                                                        |
|:---|:---|:---|:---|
| 查询容量统计 | hcloud CBR ShowStorageUsage | 查询容量统计 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowStorageUsage) |
   
#### 运营
| API名称  | 命令                               | 描述                                     | 操作                                                                                             |
|:---|:---|:---|:---|
| 变更     | hcloud CBR ChangeOrder           | 订单更新，调用该接口更新包周期产品订单信息,返回待支付订单信息。       | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ChangeOrder)           |
| 变更（废弃） | hcloud CBR UpdateOrder           | 订单更新，支付cbc订单后，调用该接口更新包周期产品订单信息。该接口已废弃。 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdateOrder)           |
| 修改付费模式 | hcloud CBR ChangeVaultChargeMode | 修改资源的付费模式，暂时只支持按需资源转包周期资源。             | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ChangeVaultChargeMode) |
   
#### 组织策略
| API名称        | 命令                                      | 描述                  | 操作                                                                                                    |
|:---|:---|:---|:---|
| 查询组织策略列表     | hcloud CBR ListOrganizationPolicies     | 查询组织策略列表            | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListOrganizationPolicies)     |
| 创建组织策略       | hcloud CBR CreateOrganizationPolicy     | 创建组织策略              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=CreateOrganizationPolicy)     |
| 查询指定组织策略     | hcloud CBR ShowOrganizationPolicy       | 查询指定组织策略            | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowOrganizationPolicy)       |
| 更新组织策略       | hcloud CBR UpdateOrganizationPolicy     | 更新组织策略              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=UpdateOrganizationPolicy)     |
| 删除组织策略       | hcloud CBR DeleteOrganizationPolicy     | 删除组织策略              | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=DeleteOrganizationPolicy)     |
| 查询组织策略部署状态列表 | hcloud CBR ListOrganizationPolicyDetail | 查询组织策略每个账号下策略部署状态列表 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListOrganizationPolicyDetail) |
   
#### 特性查询
| API名称       | 命令                      | 描述          | 操作                                                                                    |
|:---|:---|:---|:---|
| 查询服务支持的特性列表 | hcloud CBR ListFeatures | 查询服务支持的特性列表 | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ListFeatures) |
| 查询指定特性      | hcloud CBR ShowFeature  | 查询服务指定特性    | [去调试](https://console.huaweicloud.com/apiexplorer/#/openapi/CBR/cli?api=ShowFeature)  |
   
