检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 镜像服务所提供的接口分为IMS接口与OpenStack原生接口。推荐您使用IMS接口。 通过配合使用镜像服务提供的接口和OpenStack原生接口,您可以完整地使用镜像服务的所有功能。例如制作私有镜像,可以使用OpenStack原生接口,也可以使用IMS接口进行操作。
如何调用API 构造请求 认证鉴权 返回结果
历史API 镜像(OpenStack原生) 镜像标签(OpenStack原生) 镜像共享(OpenStack原生)
API 镜像 镜像标签 镜像共享 镜像复制 镜像配额 镜像任务
应用示例 使用ISO文件创建镜像
公共参数 镜像属性 镜像标签数据格式 镜像共享的约束限制 获取项目ID 相关参数取值列表
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对
镜像标签 增加或修改标签 按条件查询租户镜像标签列表 按标签查询镜像 批量添加删除镜像标签 添加镜像标签 删除镜像标签 查询镜像标签 查询租户所有镜像标签 父主题: API
镜像 查询镜像列表 更新镜像信息 制作镜像 镜像文件快速导入 使用外部镜像文件制作数据镜像 制作整机镜像 注册镜像 导出镜像 查询镜像支持的OS列表 父主题: API
镜像共享 批量删除镜像成员 批量添加镜像成员 批量更新镜像成员状态 父主题: API
镜像复制 Region内复制镜像 跨Region复制镜像 父主题: API
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
快速入门 本节通过调用一系列IMS的API使用云服务器来创建私有镜像。 API的调用方法请参见如何调用API。 使用云服务器创建私有镜像时,请确保云服务器处于关机状态。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。
镜像任务 异步任务查询 异步任务进度查询 父主题: API
注册镜像 功能介绍 该接口用于将镜像文件注册为云平台未初始化的私有镜像。 使用该接口注册镜像的具体步骤如下: 将镜像文件上传到OBS个人桶中。具体操作请参见“上传文件或文件夹”。 使用创建镜像元数据接口创建镜像元数据。调用成功后,保存该镜像的ID。创建镜像元数据请参考创建镜像元数据(OpenStack原生)。
镜像配额 查询镜像配额 父主题: API
制作镜像 功能介绍 本接口用于制作私有镜像,支持: 使用云服务器制作私有镜像(系统盘镜像/数据盘镜像)。 使用上传至OBS桶中的外部镜像文件制作系统盘镜像。 使用数据盘制作系统盘镜像。 作为异步接口,调用成功,只是说明云平台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口
导出镜像 功能介绍 该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。 导出镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。 约束与限制 仅支持导出到存储类别为标准存储的桶,并且桶和镜像在同一区域。 如下类型的私有镜像不允许导出:
删除镜像标签 功能介绍 该接口用于为镜像删除指定的标签。 约束与限制 为兼容遗留数据,不对key进行字符集校验和长度校验。 此接口为非幂等接口:如果指定删除的key不存在,则返回404状态码。 调试 您可以在API Explorer中调试该接口。 URI DELETE /v2/{
查询镜像配额 功能介绍 该接口为扩展接口,主要用于查询租户在当前Region的私有镜像的配额数量。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/cloudimages/quota 请求消息 请求参数 无 请求示例 查询镜像配额。 GET http