使用外部镜像文件制作数据镜像
功能介绍
使用上传至OBS桶中的外部数据盘镜像文件制作数据镜像。作为异步接口,调用成功,只是说明后台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务查询。
URI
POST /v1/cloudimages/dataimages/action
请求消息
- 请求参数
参数
是否必选
参数类型
描述
name
是
String
镜像名称。name参数说明请参考镜像属性。
description
否
String
镜像描述信息。
description参数说明请参考镜像属性。支持字母、数字、中文等,不支持回车、<、>,长度不能超过1024个字符。默认为空。
os_type
否
String
操作系统类型。
只能是Windows、Linux二者之一,默认Linux。
image_url
是
String
OBS桶中外部镜像文件地址。
格式为<OBS桶名>:<OBS镜像文件名称>。
说明:此处的OBS桶和镜像文件的存储类别必须是标准存储。
min_disk
是
Integer
最小数据盘大小。
取值范围40-2048GB。
cmk_id
否
String
创建加密镜像的自定义密钥,具体取值请参考《密钥管理服务用户指南》获取。
tags
否
Array of strings
镜像标签列表。默认为空。
tag的参数说明请参考镜像标签数据格式。
tags和image_tags只能使用一个。
image_tags
否
Array of ImageTag objects
新规范的镜像标签列表。默认为空。
tags和image_tags只能使用一个。
请求示例
- 使用外部镜像文件制作数据镜像,其中,镜像标签数据格式为tags,OBS桶中外部镜像文件地址为“"image-test:fedora_data1.qcow2",操作系统为Linux,数据盘大小为40G。
1 2 3 4 5 6 7 8 9 10 11 12
POST https://{Endpoint}/v1/cloudimages/dataimages/action { "name": "fedora-data1", "image_url": "image-test:fedora_data1.qcow2", "description": "fedora的数据盘1", "min_disk": 40, "tags": [ "aaa.111", "bbb.222" ], "os_type": "Linux" }
- 使用外部镜像文件制作数据镜像,其中,镜像标签数据格式为image_tags,OBS桶中外部镜像文件地址为“"image-test:fedora_data1.qcow2",操作系统为Linux,数据盘大小为40G。
1 2 3 4 5 6 7 8 9
POST https://{Endpoint}/v1/cloudimages/dataimages/action { "name": "fedora-data2", "image_url": "image-test:fedora_data1.qcow2", "description": "fedora的数据盘2", "min_disk": 40, "image_tags": [{"key":"aaa","value":"111"},{"key":"bbb","value":"222"}], "os_type": "Linux" }
响应消息
- 响应参数
参数
参数类型
描述
job_id
String
异步任务ID。
详情请参见异步任务查询。
- 响应样例
STATUS CODE 200
1 2 3
{ "job_id": "4010a32b5f909853015f90aaa24b0015" }
返回值
- 正常
- 异常
返回值
说明
400 Bad Request
请求错误,具体返回错误码请参见错误码。
401 Unauthorized
鉴权失败。
403 Forbidden
没有操作权限。
404 Not Found
找不到资源。
500 Internal Server Error
服务内部错误。
503 Service Unavailable
服务不可用。