备份新建云硬盘
最近更新时间: 2024-09-03 18:49:42
1. 接口描述
接口请求域名： brc.api3.cloud.sunhongs.com。
本接口（CreateDisksWithBackup）用于创建从备份新建云硬盘。
- 只有数据盘备份才支持新建云硬盘；
- 本接口会将备份的数据回滚到新建云硬盘上；
- 新建云硬盘的大小必须大于等于备份的大小；
- 本接口为异步接口，接口成功返回时，说明回滚任务下发成功，但不代表数据已回滚完，需要通过DescribeDiks接口查询盘状态，字段Rollbacking为true，说明盘仍在回滚中。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-25 17:27:09。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateDisksWithBackup |
| Version | 是 | 否 | String | 公共参数，本接口取值：2022-05-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| DiskType | 是 | 否 | String | 硬盘介质类型。取值范围：<br><li>CLOUD_BASIC：表示普通云硬盘<br><li>CLOUD_PREMIUM：表示高性能云硬盘<br><li>CLOUD_SSD：表示SSD云硬盘。 |
| DiskName | 否 | 否 | String | 云盘显示名称。不传则默认为“FROM backup-11112222”。最大长度不能超60个字节。 |
| DiskCount | 否 | 否 | Uint64 | 创建云硬盘数量，不传则默认为1。单次请求最多可创建的云盘数有限制。 |
| DiskChargeType | 是 | 否 | String | 付费模式，目前只有后付费，取值为POSTPAID_BY_HOUR。 |
| Placement | 是 | 否 | Placement | 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目。若不指定项目，将在默认项目下进行创建。 |
| DiskSize | 否 | 否 | Uint64 | 云硬盘大小，单位为GB。云硬盘大小必须大于等于备份大小，备份大小可通过DescribeBackups接口查询。 |
| Shareable | 否 | 否 | Bool | 可选参数，默认为False。传入True时，云盘将创建为共享型云盘。 |
| AutoSnapshotPolicyId | 否 | 否 | String | 定期快照策略ID。传入该参数时，云硬盘创建成功后将会自动绑定该定期快照策略。 |
| DiskStoragePoolGroup | 否 | 否 | String | 存储资源池组 |
| ThroughputPerformance | 否 | 否 | Uint64 | 可选参数。使用此参数可给云硬盘购买额外的性能。<br>当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）。 |
| BackupId | 是 | 否 | String | 备份ID，本接口会将此备份的数据回滚到新创建的云硬盘上。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DiskIdSet | String | 创建的云硬盘ID列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidParameter | |
| InvalidParameterValue.InvalidValue | |
| InvalidParameter.MissingParameter | |
| UnsupportedOperation.NotSupported |