1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to create snapshot groups.
- The disk list for the snapshot group creation must be mounted to the same instance. You can select all or some of the disks mounted to an instance to create a snapshot group.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-29 00:41:04.
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: CreateSnapshotGroup |
| 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 |
| DiskIds | Yes | No | Array of String | ID List of Cloud Disks for Which Snapshot Group Needing to Be Created Example: ["disk-6rag8jef"] |
| SnapshotGroupName | No | No | String | Snapshot Group Name Example: snp092101 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| SnapshotGroupId | String | Snapshot Group ID Example: csnap-oavcw09g |
| 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 |
|---|---|
| MissingParameter | Missing parameter. The request does not include the mandatory parameter. |
| InternalError.ComponentError | Third-party Component Error |
| InvalidDisk.NotSupported | The cloud disk does not support this operation. |
| InvalidParameter | Parameter error |
| InvalidDisk.SnapshotCreating | The cloud disk is creating a snapshot. Try again later. |
| InvalidDiskId.NotFound | The input DiskId does not exist. |
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| InsufficientSnapshotQuota | The snapshot quota is insufficient. |
| ResourceInUse.DiskMigrating | The cloud disk is migrating. |
| InvalidParameterValue | Invalid parameter value. The format of the parameter value is incorrect or the parameter value is not supported. |
| ResourceNotFound.NotFound | The resource does not exist. |