1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to create a snapshot for a specified cloud disk.
- Only cloud disks with the snapshot capability can create snapshots. The snapshot capability of a cloud disk can be queried through the [DescribeDisks](../CBS APIs/DescribeDisks) API. For details, see the SnapshotAbility field.
- For the limit on the number of snapshots that can be created, see the product use limits.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-29 00:40:39.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateSnapshot |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| DiskId | Yes | No | String | ID of the cloud disk that requires creating a snapshot. It can be queried through the DescribeDisks API. Example: disk-7q2iy7gp |
| SnapshotName | No | No | String | Snapshot name. If this parameter is not input, the new snapshot name defaults to "unnamed". Example: Snapshot-for-io |
| ProjectId | No | No | Int64 | Project ID of the snapshot. If this parameter is not input, it is consistent with the cloud disk project ID by default. Example: 0 |
| Tags | No | No | Array of Tag | List of tags to which the snapshot is bound. If this parameter is not input, it is consistent with the cloud disk tag by default. Example:View |
| PlatformProjectId | No | No | String | Project ID in the internal environment. It is unrelated to ProjectId in the public cloud. If it is not specified, it remains consistent with the CBS project ID. Example: pr-42749a13 |
| CreateInCluster | No | No | Bool | Whether to create the snapshot in the Outpost cluster of the cloud disk. Example: true |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| SnapshotId | String | Created snapshot ID. Example: snap-3xvkxyxp |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidDisk.NotSupportSnapshot | The cloud disk does not have the snapshot capability. |
| InvalidDisk.SnapshotCreating | The cloud disk is creating a snapshot. Try again later. |
| InvalidDisk.TypeError | Incorrect cloud disk type. |
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| InternalError.ComponentError | Third-party Component Error |
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| ResourceInUse.DiskMigrating | The cloud disk is migrating. |
| InsufficientSnapshotQuota | The snapshot quota is insufficient. |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| ResourceNotFound.NotFound | The resource does not exist. |