CreateSnapshotGroup--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

CreateSnapshotGroup

最近更新时间：2024.11.01 18:49:57首次发布时间：2024.02.01 16:03:50

调用CreateSnapshotGroup接口创建快照一致性组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateSnapshotGroup	要执行的操作，取值：CreateSnapshotGroup
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
VolumeIds.N	String	是	vol-bp1s5fnvk4gn2tws0****	云盘ID，说明如下：该云盘必须处于“已挂载”状态。如果设置多个云盘，则这些云盘需要挂载在同一个ECS实例。说明 `N`表示云盘ID的序号，多个云盘ID之间用`&`分隔，取值范围为1～16。
ProjectName	String	否	default	快照一致性组所要加入的Project（项目）名称。说明如果您在创建快照一致性组时未设置`ProjectName`，则快照一致性组默认加入default项目。
InstanceId	String	否	i-ycwyd2mvpcs6iplj****	挂载云盘的对应ECS实例ID。
Name	String	否	testName	快照一致性组的名称，说明如下：只能以中文、字母或下划线（_）开头。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。长度限制为1 ~ 128个字符。如果没有设置该参数，则在控制台上快照一致性组的名称默认为-。
Description	String	否	testDescription	快照一致性组的描述，说明如下：只能以中文、字母或下划线（_）开头。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号号（.）。长度限制为1 ~ 255个字符。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	保证请求幂等性。该字符串由您的客户端生成，用以保证不同请求之间的唯一性。说明如下：大小写敏感。不超过64个ASCII字符。
Tags.N.Key	Array of String	否	testKey	需要创建的标签键。 Tags.N.Key：`N`表示标签键的序号。取值范围：1～20。多个标签键之间用`&`分隔。命名规则如下：不能以任何大小写形式的`volc:`或`sys:`开头，`volc:`或`sys:`开头为系统预留标签键，禁止创建。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度限制为1～128个字符。
Tags.N.Value	Array of String	否	testValue	标签的标签值。 Tags.N.Value：`N`表示标签值的序号。取值范围：1～20。多个标签值之间用`&`分隔。命名规则如下：只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。允许为空，长度限制为0～256个字符。

返回数据

名称	类型	示例值	描述
SnapshotGroupId	String	sg-3tigy72q3u3vj0x2****	快照一致性组ID。

请求示例

GET /?Action=CreateSnapshotGroup&Version=2020-04-01&VolumeIds.1=vol-9v6jblj39w9koo2x**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022050520060001021207006918C1****",
        "Action": "ModifySnapshotGroup",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "SnapshotGroupId": "sg-7e2gbxchg89jwlc****"
    }
}

错误码

HttpCode	错误码	错误信息
400	ErrSnapshotQuotaExceed	快照额度超过限制。
400	VolumeInCreatingSnapshot	云盘有创建中的快照。
400	InvalidProjectName	指定的项目名称不合法。
400	InvalidParameter.Name	指定的名称格式不合法。
400	InvalidParameter.Description	指定的描述格式不合法。
400	MissingParameter.VolumeIds	缺少VolumeIds参数。
404	VolumeNotFound	云盘未找到。
400	AbnormalVolumeStatus	云盘状态异常。
400	VolumeTypeNotSupportSnapshot	该云盘类型不支持快照。