检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 镜像服务所提供的接口分为IMS接口与OpenStack原生接口。推荐您使用IMS接口。 通过配合使用镜像服务提供的接口和OpenStack原生接口,您可以完整地使用镜像服务的所有功能。例如制作私有镜像,可以使用OpenStack原生接口,也可以使用IMS接口进行操作。
API 镜像 镜像标签 镜像共享 镜像复制 镜像配额 镜像任务
如何调用API 构造请求 认证鉴权 返回结果
历史API 镜像(OpenStack原生) 镜像标签(OpenStack原生) 镜像共享(OpenStack原生)
查询指定版本信息(OpenStack原生) 功能介绍 查询指定版本API的信息,包括该版本API的兼容性、域名信息等。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 api_version 是 String API版本号。例如:v2.0 请求消息
查询镜像视图(OpenStack原生) 功能介绍 该接口主要用于查询镜像视图,通过视图,用户可以了解到镜像包含哪些属性,同时也可以了解每个属性的数据类型等。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/schemas/image 请求消息 请求参数
查询镜像标签 功能介绍 该接口用于查询指定镜像上的所有标签。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/{project_id}/images/{image_id}/tags 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述
查询版本列表(OpenStack原生) 功能介绍 查询API的版本信息列表,包括API的版本兼容性、域名信息等。 URI GET / 请求消息 请求参数 无 请求示例 查询API的版本信息列表。 GET https://{Endpoint}/ 响应消息 响应参数 参数 参数类型 描述
根据2得到的镜像ID,使用注册镜像接口注册OBS桶中的镜像文件。 注册镜像接口作为异步接口,调用成功后,说明后台收到了注册请求。需要根据镜像ID查询该镜像状态验证镜像注册是否成功。当镜像状态变为“active”时,表示镜像注册成功。 如何查询异步任务,请参见异步任务查询。 注册镜像前请确保用户已拥有对象存储服务的Tenant
OpenStack原生API 镜像(OpenStack原生) 镜像视图(OpenStack原生) 镜像共享(OpenStack原生) 查询API版本信息(OpenStack原生)
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
权限和授权项 权限及授权项说明 镜像管理 镜像标签 镜像视图 镜像共享 镜像复制 镜像配额
功能介绍 该接口用于为指定镜像添加或更新指定的单个标签。 约束与限制 每个标签由键值对组成,标签的key的长度不超过36个字符,value的长度不超过43个字符。key不能为空或空白字符串,value不能为空,但可以是空白字符串。 单个镜像最多添加10个标签。 此接口为幂等接口:如果创
invalid.", "code": "IMG.0024" } } 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 IMG.0001 The request
evs:volumes:* √ √ 注册镜像 PUT /v1/cloudimages/{image_id}/upload 说明: 注册镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。 必须配置default的企业项目权限,才能正常使用企业项目权限注册镜像。 ims:images:upload
创建私有镜像 创建方式导航 通过云服务器创建Windows系统盘镜像 通过云服务器创建Linux系统盘镜像 通过外部镜像文件创建Windows系统盘镜像 通过外部镜像文件创建Linux系统盘镜像 创建裸金属服务器系统盘镜像 通过数据盘创建数据盘镜像 通过外部镜像文件创建数据盘镜像
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要
镜像共享 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目(Project) 企业项目(Enterprise Project) 添加镜像成员(OpenStack原生) POST /v2/images/{image_id}/members ims:images:get
异步任务查询 功能介绍 该接口为扩展接口,主要用于查询异步接口执行情况,比如查询导出镜像任务的执行状态。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/{project_id}/jobs/{job_id} 参数说明请参见表1。 表1 参数说明 参数
镜像配额 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目(Project) 企业项目(Enterprise Project) 查询镜像配额 GET /v1/cloudimages/quota ims:quotas:get - √ √ 父主题: 权限和授权项