创建快照
最近更新时间: 2024-06-18 14:31:18
1. 接口描述
接口请求域名： cbs.api3.fincloud.tencent.cn。
本接口（CreateSnapshot）用于对指定云盘创建快照。
- 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由DescribeDisks接口查询，见SnapshotAbility字段。
- 可创建快照数量限制见产品使用限制。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-10-09 16:34:36。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateSnapshot |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| DiskId | 是 | 否 | String | 需要创建快照的云硬盘ID，可通过DescribeDisks接口查询。 |
| SnapshotName | 否 | 否 | String | 快照名称，不传则新快照名称默认为“未命名”。 |
| ProjectId | 否 | 否 | Int64 | 快照的项目ID，不传则默认与云盘项目ID保持一致。 |
| Tags | 否 | 否 | Array of Tag | 快照绑定的标签列表，不传则默认与云盘标签保持一致。 |
| PlatformProjectId | 否 | 否 | String | TCE环境的项目ID，与公有云的ProjectId不相关，不传则与云盘项目保持一致。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SnapshotId | String | 新创建的快照ID。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidDisk.NotSupportSnapshot | |
| InvalidDisk.SnapshotCreating | |
| InvalidDisk.TypeError | |
| InvalidDiskId.NotFound | |
| InvalidParameterValue | |
| InternalError.ComponentError | |
| MissingParameter | |
| ResourceInUse.DiskMigrating | |
| InsufficientSnapshotQuota | |
| InvalidDisk.NotSupported | |
| InvalidAccount.InsufficientBalance |