tencent cloud

APIs

CreateSnapshotGroup

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-12 19:37:34

1. API Description

Domain name for API request: cbs.intl.tencentcloudapi.com.

This API is used to create a snapshot group.
This API is used to create snapshot groups. The CBS list must be mounted on the same instance.
This API is used to create snapshot groups for all or some of the disks mounted to instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateSnapshotGroup.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DiskIds.N Yes Array of String Specifies the cloud disk ID list for creating snapshot groups. disks mounted on the same instance must be selected.
SnapshotGroupName No String Snapshot group name. snapshots associated with the snapshot group inherit the snapshot group name. example: if the snapshot group name is testSnapshotGroup and the snapshot group is associated with two snapshots, the snapshot names are testSnapshotGroup_0 and testSnapshotGroup_1 respectively.
Tags.N No Array of Tag Specifies the Tag list that should be bound to the snapshot group.

3. Output Parameters

Parameter Name Type Description
SnapshotGroupId String Specifies the snapshot group ID created successfully.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a Snapshot Group

This example shows you how to create a snapshot group.

Input Example

https://cbs.intl.tencentcloudapi.com/?Action=CreateSnapshotGroup
&DiskIds.0=disk-lt8ajfvk
&DiskIds.1=disk-1ly0wu8c
&SnapshotGroupName=testSnapshotGroup
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "c9f12982-0c74-4d7e-aaeb-dd965ff2c9dc",
        "SnapshotGroupId": "csnap-oavcw09g"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InsufficientSnapshotQuota Insufficient snapshot quota.
InternalError.ComponentError Dependent component request failed. Please contact customer service.
InvalidAccount.InsufficientBalance Insufficient account balance
InvalidDisk.NotSupported Indicates that the operation is not supported for the cloud disk.
InvalidDisk.SnapshotCreating A snapshot is being created for the cloud disk. Try again later.
InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter.
ResourceInUse The resource is in use.
ResourceInUse.DiskMigrating The cloud disk is being migrated. Try again later.
ResourceInUse.DiskRollbacking The cloud disk is being rolled back. Please try again later.
ResourceNotFound.NotFound The resource is not found.
ResourceUnavailable.NotSupported The resource does not support this operation.
ResourceUnavailable.SnapshotCreating Unable to use: the snapshot is being created

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan