文档首页/ 镜像服务 IMS/ API参考/ 快速入门
更新时间：2024-06-24 GMT+08:00
查看PDF
分享

快速入门

本节通过调用一系列IMS的API使用云服务器来创建私有镜像。

API的调用方法请参见如何调用API。

  • 使用云服务器创建私有镜像时，请确保云服务器处于关机状态。
  • 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

涉及API

当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。

  • IAM获取token的API
  • IMS创建镜像的API

具体步骤

  1. Token认证，具体操作请参考认证鉴权。
  2. 发送“POST https://IMS的Endpoint/v2/cloudimages/action”。
  3. 在Request Header中增加“X-Auth-Token”。
  4. 在Request Body中传入参数如下： 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
    		 
    {
    "name": "ims_test",  //镜像名称（必填String）
    "description": "云服务器制作镜像",  //镜像描述（非必填String）
    "instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",  //云服务器ID（必填String）
    "tags": [  
             "aaa.111",  
             "bbb.333",  
             "ccc.444"  
    ]  //镜像标签列表（非必填List<String>）
}

    请求响应成功后，返回job_id。

    若请求失败，则会返回错误码及对应的错误信息说明，详细错误码信息请参考错误码。

  1. 根据job_id查询job详情，具体操作请参考异步任务查询。

    查询job详情返回状态status为“SUCCESS”，则表示私有镜像创建成功。

    请求异常返回值说明请参考状态码。

  2. 查询job详情的body体中可以获取到image_id，即镜像ID，根据获取到的镜像ID可对镜像进行查询、删除、导出等操作。