API概览 镜像服务所提供的接口分为IMS接口与OpenStack原生接口。推荐您使用IMS接口。 通过配合使用镜像服务提供的接口和OpenStack原生接口,您可以完整地使用镜像服务的所有功能。例如制作私有镜像,可以使用OpenStack原生接口,也可以使用IMS接口进行操作。
历史API 镜像 镜像配额 镜像(OpenStack原生) 镜像标签(OpenStack原生) 镜像共享(OpenStack原生)
API 镜像 镜像标签 镜像共享 镜像复制 镜像配额 镜像任务
OpenStack原生API 镜像(OpenStack原生) 镜像视图(OpenStack原生) 镜像共享(OpenStack原生) 查询API版本信息(OpenStack原生)
查询API版本信息(OpenStack原生) 查询版本列表(OpenStack原生) 查询指定版本信息(OpenStack原生) 父主题: OpenStack原生API
更新镜像信息 制作镜像 镜像文件快速导入 使用外部镜像文件制作数据镜像 制作整机镜像 注册镜像 导出镜像 查询镜像支持的OS列表 父主题: API
如何调用API 构造请求 认证鉴权 返回结果
查询租户所有镜像标签 功能介绍 该接口用于查询租户的所有镜像上的标签。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/{project_id}/images/tags 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 project_id
查询版本列表(OpenStack原生) 功能介绍 查询API的版本信息列表,包括API的版本兼容性、域名信息等。 URI GET / 请求消息 请求参数 无 请求示例 查询API的版本信息列表。 GET https://{Endpoint}/ 响应消息 响应参数 参数 参数类型 描述
导出镜像 功能介绍 该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。 导出镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。 约束与限制 仅支持导出到存储类别为标准存储的桶,并且桶和镜像在同一区域。 如下类型的私有镜像不允许导出:
查询镜像标签 功能介绍 该接口用于查询指定镜像上的所有标签。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/{project_id}/images/{image_id}/tags 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述
查询指定版本信息(OpenStack原生) 功能介绍 查询指定版本API的信息,包括该版本API的兼容性、域名信息等。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 api_version 是 String API版本号。例如:v2.0 请求消息
注册镜像 功能介绍 该接口用于将镜像文件注册为云平台未初始化的私有镜像。 使用该接口注册镜像的具体步骤如下: 将镜像文件上传到OBS个人桶中。具体操作请参见“上传文件或文件夹”。 使用创建镜像元数据接口创建镜像元数据。调用成功后,保存该镜像的ID。创建镜像元数据请参考创建镜像元数据(OpenStack原生)。
删除镜像标签 功能介绍 该接口用于为镜像删除指定的标签。 约束与限制 为兼容遗留数据,不对key进行字符集校验和长度校验。 此接口为非幂等接口:如果指定删除的key不存在,则返回404状态码。 调试 您可以在API Explorer中调试该接口。 URI DELETE /v2/{
说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。
批量删除镜像标签 功能介绍 该接口用于为指定镜像批量删除标签。 约束与限制 此接口为幂等接口,如果指定的标签不存在,则默认视为删除成功。 对标签的key、value不做字符集范围校验,key不允许为空或空白字符串;value为可选,且不对value做校验。如果要删除的标签不存在,
参数 参数类型 描述 type String 查询的资源类型。 used Integer 已使用的资源配额。 quota Integer 查询出的资源的总配额。 min Integer 资源的最小配额。 max Integer 资源的最大配额。 响应样例 STATUS CODE 200
功能介绍 该接口用于为指定镜像添加或更新指定的单个标签。 约束与限制 每个标签由键值对组成,标签的key的长度不超过36个字符,value的长度不超过43个字符。key不能为空或空白字符串,value不能为空,但可以是空白字符串。 单个镜像最多添加10个标签。 此接口为幂等接口:如果创
参数 参数类型 描述 type String 查询的资源类型。 used Integer 已使用的资源配额。 quota Integer 查询出的资源的总配额。 min Integer 资源的最小配额。 max Integer 资源的最大配额。 响应样例 STATUS CODE 200
增加或修改标签 功能介绍 该接口主要用于为某个镜像增加或修改一个自定义标签。通过自定义标签,用户可以将镜像进行分类。 调试 您可以在API Explorer中调试该接口。 URI PUT /v1/cloudimages/tags 请求消息 请求参数 参数 是否必选 参数类型 描述
您即将访问非华为云网站,请注意账号财产安全