检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 镜像服务所提供的接口分为IMS接口与OpenStack原生接口。推荐您使用IMS接口。 通过配合使用镜像服务提供的接口和OpenStack原生接口,您可以完整地使用镜像服务的所有功能。例如制作私有镜像,可以使用OpenStack原生接口,也可以使用IMS接口进行操作。
如何调用API 构造请求 认证鉴权 返回结果
历史API 镜像(OpenStack原生) 镜像标签(OpenStack原生) 镜像共享(OpenStack原生)
API 镜像 镜像标签 镜像共享 镜像复制 镜像配额 镜像任务
查询API版本信息(OpenStack原生) 查询版本列表(OpenStack原生) 查询指定版本信息(OpenStack原生) 父主题: OpenStack原生API
OpenStack原生API 镜像(OpenStack原生) 镜像视图(OpenStack原生) 镜像共享(OpenStack原生) 查询API版本信息(OpenStack原生)
请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。
查询镜像标签 功能介绍 该接口用于查询指定镜像上的所有标签。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/{project_id}/images/{image_id}/tags 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述
invalid.", "code": "IMG.0024" } } 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 IMG.0001 The request
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
Region内复制镜像 功能介绍 该接口为扩展接口,主要用于用户将一个已有镜像复制为另一个镜像。复制镜像时,可以更改镜像的加密等属性,以满足不同的场景。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed
镜像复制 Region内复制镜像 跨Region复制镜像 父主题: API
批量添加镜像成员 功能介绍 该接口为扩展接口,主要用于镜像共享时用户将多个镜像共享给多个用户。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询。 调试
功能介绍 查询指定版本API的信息,包括该版本API的兼容性、域名信息等。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 api_version 是 String API版本号。例如:v2.0 请求消息 请求参数 无 请求示例
镜像任务 异步任务查询 异步任务进度查询 父主题: API
查询镜像视图(OpenStack原生) 功能介绍 该接口主要用于查询镜像视图,通过视图,用户可以了解到镜像包含哪些属性,同时也可以了解每个属性的数据类型等。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/schemas/image 请求消息 请求参数
导出镜像 功能介绍 该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。 导出镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。 约束与限制 仅支持导出到存储类别为标准存储的桶,并且桶和镜像在同一区域。 如下类型的私有镜像不允许导出:
删除标签(OpenStack原生) 功能介绍 该接口主要用于删除某个镜像的自定义标签,通过该接口,用户可以将私有镜像中一些不用的标签删除。 当前接口已废弃,推荐使用以下接口。 如果需要为镜像删除指定的标签时,请使用删除镜像标签。 如果需要为指定镜像批量添加/更新、删除标签时,请使用批量添加删除镜像标签。
更新镜像信息 制作镜像 镜像文件快速导入 使用外部镜像文件制作数据镜像 制作整机镜像 注册镜像 导出镜像 查询镜像支持的OS列表 父主题: API
查询版本列表(OpenStack原生) 功能介绍 查询API的版本信息列表,包括API的版本兼容性、域名信息等。 URI GET / 请求消息 请求参数 无 请求示例 查询API的版本信息列表。 GET https://{Endpoint}/ 响应消息 响应参数 参数 参数类型 描述 versions