文档首页/ 镜像服务 IMS/ API参考/ API/ 镜像/ 使用外部镜像文件制作数据镜像（新） - CreateDataImageInSafeMode
更新时间：2026-07-07 GMT+08:00
查看PDF
分享

使用外部镜像文件制作数据镜像（新） - CreateDataImageInSafeMode

功能介绍

使用上传至OBS桶中的外部数据盘镜像文件制作数据镜像。作为异步接口，调用成功，只是说明后台收到了制作请求，镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态，具体请参考异步任务进度查询 - ShowJobProgress。

华为云不再提供Windows操作系统类型的镜像，该接口不再支持外部文件制作Windows数据盘镜像。

约束与限制

制作加密镜像场景需要租户有KMS相关action权限。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v2.1/cloudimages/dataimages/action

请求消息

  • 请求参数

    参数

    是否必选

    参数类型

    描述

    name

    是

    String

    参数解释：

    镜像名称。name参数说明请参考镜像属性。

    约束限制：

    • 名称的首尾字母不能为空格。
    • 名称的长度为1～128位。

    取值范围：

    只能由中文、字母、数字、空格和特殊字符 - _ . 组成，且首尾字符都不能为空格。

    默认取值：

    不涉及

    description

    否

    String

    参数解释：

    镜像描述信息。description参数说明请参考镜像属性。

    约束限制：

    支持字母、数字、中文等，不支持回车、<、>，长度不能超过1024个字符。

    取值范围：

    不涉及

    默认取值：

    不涉及

    os_type

    否

    String

    参数解释：

    操作系统类型。

    约束限制：

    不涉及

    取值范围：

    Windows或Linux。

    默认取值：

    默认Linux

    image_url

    是

    String

    参数解释：

    OBS桶中外部镜像文件地址。

    约束限制：

    在使用OBS桶的外部镜像文件制作镜像时生效且为必选字段。格式为<OBS桶名>:<OBS镜像文件名称>。

    说明：

    此处的OBS桶和镜像文件的存储类别必须是标准存储。

    取值范围：

    不涉及

    默认取值：

    不涉及

    min_disk

    是

    Integer

    参数解释：

    最小数据盘大小。

    约束限制：

    不涉及

    取值范围：

    Linux操作系统取值为10～1024GB，Windows操作系统取值为20～1024GB。

    默认取值：

    不涉及

    cmk_id

    否

    String

    参数解释：

    创建加密镜像的自定义密钥

    约束限制：

    不涉及

    取值范围：

    具体取值请参考《密钥管理服务用户指南》获取。

    默认取值：

    不涉及

    tags

    否

    Array of strings

    参数解释：

    镜像标签列表。tag的参数说明请参考镜像标签数据格式。

    约束限制：

    tags和image_tags只能使用一个。

    取值范围：

    • 标签的键可以包含任意语种字母、数字、空格和 _ . : + - @，但首尾不能含有空格，不能以sys_开头。
    • 标签的值可以包含任意语种字母、数字、空格和_ . : / + - @，但首尾不能含有空格。

    默认取值：

    不涉及

    image_tags

    否

    Array of ImageTag objects

    参数解释：

    新规范的镜像标签列表。image_tags数据结构说明请参见表1 image_tags数据结构说明。

    约束限制：

    tags和image_tags只能使用一个。

    取值范围：

    • 标签的键可以包含任意语种字母、数字、空格和 _ . : + - @，但首尾不能含有空格，不能以sys_开头。
    • 标签的值可以包含任意语种字母、数字、空格和_ . : / + - @，但首尾不能含有空格。

    默认取值：

    不涉及

    enterprise_project_id

    否

    String

    参数解释：

    表示当前镜像所属的企业项目。

    关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。

    约束限制：

    如果只使用企业项目授权，必须传入enterprise_project_id参数，否则可能会出现报错无权限。

    取值范围：

    • 取值为0或无该值，表示属于default企业项目。
    • 取值为UUID，表示属于该UUID对应的企业项目。

    默认取值：

    不涉及
    表1 参数：image_tags

    名称

    是否必选

    参数类型

    描述

    key

    否

    string

    参数解释：

    标签的键。

    约束限制：

    长度不能超过128个字符。

    取值范围：

    标签的键可以包含任意语种字母、数字、空格和 _ . : + - @，但首尾不能含有空格，不能以sys_开头。

    默认取值：

    不涉及

    value

    否

    string

    参数解释：

    标签的值。

    约束限制：

    长度不能超过255个字符。

    取值范围：

    标签的值可以包含任意语种字母、数字、空格和_ . : / + - @，但首尾不能含有空格。

    默认取值：

    不涉及

请求示例

  • 使用外部镜像文件制作数据镜像，其中，镜像标签数据格式为tags，OBS桶中外部镜像文件地址为“"image-test:fedora_data1.qcow2"，操作系统为Linux，数据盘大小为40G。 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    		 
    POST https://{Endpoint}/v2.1/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}/v2.1/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。

    详情请参见6.6.2-异步任务进度查询 - ShowJobProgress。

    取值范围：

    不涉及
  • 响应样例 
    STATUS CODE 200
    1
2
3
    		 
    {
    "job_id": "4010a32b5f909853015f90aaa24b0015"
}

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误，具体返回错误码请参见错误码。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。
父主题： 镜像