文档首页/ 云硬盘 EVS/ API参考/ Cinder API/ 快照管理/ CreateSnapshotPreheat
更新时间：2024-10-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

CreateSnapshotPreheat

功能介绍

使用快照预热能力对资源进行预热。

调用方法

请参见如何调用API。

URI

POST /v5/{project_id}/snapshots/preheat

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。 获取方法请参见"获取项目ID"。 项目ID。 获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

preheat

否

preheat object

快照的预热信息。
表4 preheat

参数

是否必选

参数类型

描述

source_type

否

String

预热来源的类型，当前仅支持"image"。

source_id

否

String

预热来源的资源ID。

availability_zone

否

String

需要预热的AZ。

volume_type

否

String

预热的云硬盘类型。

count

否

String

预热的数量。

响应参数

状态码： 202

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of CreateSnapshotPreheatResponseBody objects
表6 CreateSnapshotPreheatResponseBody

参数

参数类型

描述

job_id

String

创建预热的任务ID。

snapshot_id

String

预热产生的快照ID。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ErrorResponseBody objects

Bad Request
表8 ErrorResponseBody

参数

参数类型

描述

error

Error object

出现错误时，返回的错误信息。
表9 Error

参数

参数类型

描述

code

String

出现错误时，返回的错误码。

错误码和其对应的含义请参考错误码说明。

message

String

出现错误时，返回的错误消息。

请求示例

POST https://{endpoint}/v5/{project_id}/snapshots/preheat

{
  "preheat" : {
    "source_type" : "image",
    "source_id" : "xxxxxxx",
    "availability_zone" : "az1",
    "volume_type" : "SSD",
    "count" : "100"
  }
}

响应示例

状态码： 202

{
  "job_id" : "xxxx",
  "snapshot_id" : "xxxxxx"
}

状态码： 400

Bad Request

{
  "error" : {
    "code" : "EVS.xxxx",
    "message" : "xxxxx"
  }
}

状态码

状态码

描述

202

400

Bad Request

错误码

请参见错误码。

父主题： 快照管理

相关文档