You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

CreateSnapshot

最近更新时间：2024.04.25 17:11:26

首次发布时间：2022.04.28 10:05:43

我的收藏

调用CreateSnapshot接口为云盘创建一个快照。

调试

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

注意事项

  • 仅极速型SSD云盘支持创建快照。
  • 创建快照前，云盘必须处于“可用”状态或“已挂载”状态。
  • 如果云盘处于“已挂载”状态，那么挂载云盘的实例需处于“运行中”或“已停止”状态。
  • 云盘的快照数量未超过单盘的快照数量上限。

注意

  • 免费期间，每个云盘最多可以创建10个手动快照。
  • 更多注意事项，请参见创建快照。

请求参数

名称类型是否必填
示例值
描述
ActionString是CreateSnapshot要执行的操作，取值：CreateSnapshot
VolumeIdString是vol-bp1s5fnvk4gn2tws0****需要创建快照的云盘ID。

SnapshotName

String

是

testSnapshotName

创建的快照名称。命名规范如下：

  • 长度限制为1~128个字符。
  • 只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。
  • 为防止和自动快照的名称冲突，不能以“auto”开头。
DescriptionString否testDescription快照描述信息，默认为空，长度限制为0~255个字符。
ClientTokenString否123e4567-e89b-12d3-a456-42665544****用以保证请求幂等性。该字符串由您的客户端生成，用以保证不同请求之间的唯一性。ClientToken是一个大小写敏感、不超过64个ASCII字符的字符串。

ProjectName

String

否

default

快照所要加入的Project（项目）名称。

注意

  • 快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。
  • 如果您在创建快照时未设置ProjectName，快照会默认加入default项目。

Tags.N.Key

String

否

Tags.1.Key=tag

需要创建的标签键。

  • Tags.N.Key：N表示标签键的序号。取值范围：1～20。

  • 多个标签键之间用&分隔。

命名规则如下：

  • 不能以任何大小写形式的volc:或sys:开头，volc:或sys:开头为系统预留标签键，禁止创建。

  • 只能包含语言字符、数字、空格和特殊符号_.:/=+-@。

  • 长度限制在1～128个字符之间。

Tags.N.Value

String

否

Tags.1.Value=test

标签的标签值。

  • Tags.N.Value：N表示标签值的序号。取值范围：1～20。

  • 多个标签值之间用&分隔。

命名规则如下：

  • 只能包含语言字符、数字、空格和特殊符号_.:/=+-@。

  • 允许为空，长度限制在0～256个字符之间。

返回数据

名称类型示例值说明
SnapshotIdStringsnap-j4pajdjui4c7e4ma****创建的快照ID。

请求示例

GET /?Action=CreateSnapshot&SnapshotName=snapshot_name&Version=2020-04-01&VolumeId=vol-bp1s5fnvk4gn2tws0**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
		"ResponseMetadata": {
				"RequestId": "20220308180931010225243139000DF***",
				"Action": "CreateSnapshotSnapshot",
				"Version": "2020-04-01",
				"Service": "storage_ebs",
				"Region": "cn-beijing"
		},
		"Result": {
			  "SnapshotId": "snap-j4pajdjui4c7e4ma****"
		}
}

错误码

HttpCode错误码错误信息
400ErrSnapshotQuotaExceed快照额度超过限制
400VolumeTypeNotSupportSnapshot云盘不支持快照
404SnapshotNotFound未找到快照
400InvalidSnapshotName快照名称格式不合法
400InvalidDescription资源描述格式不合法
400IncorrectInstanceStatus实例状态不支持此操作
400VolumeInCreatingSnapshot云盘有创建中的快照
400InvalidProjectName指定的项目名不合法。
400IdempotentParameterMismatch幂等参数不一致