1. 接口描述
接口请求域名： cbs.api3.gsesgpucloud.com。
本接口（CreateSnapshot）用于对指定云盘创建快照。
- 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由DescribeDisks接口查询，见SnapshotAbility字段。
- 可创建快照数量限制见 产品使用限制。
默认接口请求频率限制：20次/秒。
接口更新时间：2024-07-15 23:00:10。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateSnapshot |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| 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 | 输入的DiskId不存在。 |
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
| InternalError.ComponentError | 第三方组件错误 |
| MissingParameter | 参数缺失。请求没有带必选参数。 |
| ResourceInUse.DiskMigrating | 云盘正在迁移中 |
| InsufficientSnapshotQuota | 快照配额不足。 |
| InvalidDisk.NotSupported | 云硬盘不支持该操作。 |
| InvalidAccount.InsufficientBalance | 账户余额不足。 |