检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 镜像 镜像标签 镜像共享 镜像复制 镜像配额 镜像任务
历史API 镜像(OpenStack原生) 镜像标签(OpenStack原生) 镜像共享(OpenStack原生)
API概览 镜像服务所提供的接口分为IMS接口与OpenStack原生接口。推荐您使用IMS接口。 通过配合使用镜像服务提供的接口和OpenStack原生接口,您可以完整地使用镜像服务的所有功能。例如制作私有镜像,可以使用OpenStack原生接口,也可以使用IMS接口进行操作。
如何调用API 构造请求 认证鉴权 返回结果
查询镜像标签 功能介绍 该接口用于查询指定镜像上的所有标签。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/{project_id}/images/{image_id}/tags 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述
OpenStack原生API 镜像(OpenStack原生) 镜像视图(OpenStack原生) 镜像共享(OpenStack原生) 查询API版本信息(OpenStack原生)
查询镜像视图(OpenStack原生) 功能介绍 该接口主要用于查询镜像视图,通过视图,用户可以了解到镜像包含哪些属性,同时也可以了解每个属性的数据类型等。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/schemas/image 请求消息 请求参数
查询API版本信息(OpenStack原生) 查询版本列表(OpenStack原生) 查询指定版本信息(OpenStack原生) 父主题: OpenStack原生API
注册镜像 功能介绍 该接口用于将镜像文件注册为云平台未初始化的私有镜像。 使用该接口注册镜像的具体步骤如下: 将镜像文件上传到OBS个人桶中。具体操作请参见“上传文件或文件夹”。 使用创建镜像元数据接口创建镜像元数据。调用成功后,保存该镜像的ID。创建镜像元数据请参考创建镜像元数据(OpenStack原生)。
删除镜像标签 功能介绍 该接口用于为镜像删除指定的标签。 约束与限制 为兼容遗留数据,不对key进行字符集校验和长度校验。 此接口为非幂等接口:如果指定删除的key不存在,则返回404状态码。 调试 您可以在API Explorer中调试该接口。 URI DELETE /v2/{
查询镜像配额 功能介绍 该接口为扩展接口,主要用于查询租户在当前Region的私有镜像的配额数量。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/cloudimages/quota 请求消息 请求参数 无 请求示例 查询镜像配额。 GET http
查询指定版本信息(OpenStack原生) 功能介绍 查询指定版本API的信息,包括该版本API的兼容性、域名信息等。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 api_version 是 String API版本号。例如:v2.0 请求消息
导出镜像 功能介绍 该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。 导出镜像前请确保用户已拥有对象存储服务的Tenant Administrator权限。 约束与限制 仅支持导出到存储类别为标准存储的桶,并且桶和镜像在同一区域。 如下类型的私有镜像不允许导出:
查询租户所有镜像标签 功能介绍 该接口用于查询租户的所有镜像上的标签。 调试 您可以在API Explorer中调试该接口。 URI GET /v2/{project_id}/images/tags 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 project_id
查询版本列表(OpenStack原生) 功能介绍 查询API的版本信息列表,包括API的版本兼容性、域名信息等。 URI GET / 请求消息 请求参数 无 请求示例 查询API的版本信息列表。 GET https://{Endpoint}/ 响应消息 响应参数 参数 参数类型 描述
异步任务查询 功能介绍 该接口为扩展接口,主要用于查询异步接口执行情况,比如查询导出镜像任务的执行状态。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/{project_id}/jobs/{job_id} 参数说明请参见表1。 表1 参数说明 参数
功能介绍 该接口用于为指定镜像添加或更新指定的单个标签。 约束与限制 每个标签由键值对组成,标签的key的长度不超过36个字符,value的长度不超过43个字符。key不能为空或空白字符串,value不能为空,但可以是空白字符串。 单个镜像最多添加10个标签。 此接口为幂等接口:如果创
批量添加镜像成员 功能介绍 该接口为扩展接口,主要用于镜像共享时用户将多个镜像共享给多个用户。 该接口为异步接口,返回job_id说明任务下发成功,查询异步任务状态,如果是success说明任务执行成功,如果是failed说明任务执行失败。如何查询异步任务,请参见异步任务查询。 调试
增加或修改标签 功能介绍 该接口主要用于为某个镜像增加或修改一个自定义标签。通过自定义标签,用户可以将镜像进行分类。 调试 您可以在API Explorer中调试该接口。 URI PUT /v1/cloudimages/tags 请求消息 请求参数 参数 是否必选 参数类型 描述
异步任务进度查询 功能介绍 该接口为扩展接口,主要用于查询异步任务进度。 URI GET /v1/cloudimages/job/{job_id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 job_id 是 异步任务ID 请求消息 请求参数 无 请求示例 异步任务进度查询。