QingCloud 文档 – 镜像 - kaiyun官方网站下载手机网页

Development_docs: CaptureImageFromSnapshot

Mon, 01 Jan 0001 00:00:00 +0000

将指定备份导出为镜像。请注意，此备份点可以为云服务器或特定类型的硬盘(不支持企业级分布式 SAN (NeonSAN) 硬盘)的备份点才能导出为镜像。如果用硬盘的备份点导出镜像,请务必保证硬盘中的文件系统是完好的，可以启动的。

Request Parameters

Parameter name	Type	Description	Required
snapshot	String	备份 ID	Yes
image_name	String	镜像名称	No
description	String	镜像的描述信息	No
base_image	String	使用快照制作镜像时,新生成镜像的很多参数使用镜像 base_image 的；当 snapshot_id 是硬盘时，此参数是必须的	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	Job ID
image_id	String	新的镜像 ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request

https://api.qingcloud.com/iaas/?action=CaptureImageFromSnapshot
&snapshot=ss-yp2b9l7v
&image_name=image_from_snapshot
&base_image=xenialx64b
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"CaptureImageFromSnapshotResponse",
  "image_id":"img-rd7siwov",
  "job_id":"j-2h1syb70",
  "ret_code":0
}

Development_docs: CaptureInstance

Mon, 01 Jan 0001 00:00:00 +0000

将某个已关闭的云服务器制作成模板（或称“自有镜像”），之后便可将其用于创建新的云服务器。被捕获的云服务器必须是已关闭（ stopped ）状态，否则会返回错误。

由云服务器制成的自有镜像，会保留云服务器中安装的软件、配置及数据，因此基于这个自有镜像创建的云服务器，就直接获得了相同的系统环境。

Request Parameters

Parameter name	Type	Description	Required
instance	String	要被制作为模板的云服务器	Yes
image_name	String	镜像名称	No
zone	String	区域 ID，注意要小写	Yes
target_user	String	目标用户 ID ，可用于主账号为其子账号创建资源。	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
image_id	String	新创建的镜像 ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=CaptureInstance
&instance=i-n3nju2rh
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"CaptureInstanceResponse",
  "job_id":"j-bm6ym3r8",
  "image_id":"img-j38f2h3h"
  "ret_code":0
}

Development_docs: CloneImages

Mon, 01 Jan 0001 00:00:00 +0000

从一个镜像克隆多个镜像。

Request Parameters

Parameter name	Type	Description	Required
image	String	需要克隆的原始镜像 ID	Yes
count	Integer	克隆镜像的数量，默认是1	No
image_name	String	镜像名称注解如果不指定，则和原始镜像名称一致	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=CloneImages
&image=img-rtyv0968
&count=1
&image_name=clone
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"CloneImagesResponse",
      "images":[
      "img-0qdcwle5"
      ],
      "job_id":"j-vrh2lpwt",
  "ret_code":0
}

Development_docs: DeleteImages

Mon, 01 Jan 0001 00:00:00 +0000

删除一个或多个自有镜像。镜像须在可用（ available ）状态下才能被删除。

Request Parameters

Parameter name	Type	Description	Required
images.n	String	镜像 ID	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=DeleteImages
&images.1=img-uydrnlax
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"DeleteImagesResponse",
  "job_id":"j-bm6ym3r8",
  "ret_code":0
}

Development_docs: DescribeImages

Mon, 01 Jan 0001 00:00:00 +0000

获取一个或多个镜像。

可根据镜像ID，状态，镜像名称、操作系统平台作过滤条件，来获取镜像列表。如果不指定任何过滤条件，默认返回你所拥有的所有镜像。如果指定不存在的镜像ID，或非法状态值，则会返回错误信息。

Request Parameters

Parameter name	Type	Description	Required
images.n	String	镜像ID	No
processor_type	String	镜像支持的处理器类型，有效值为 64bit 和 32bit	No
os_family	String	镜像操作系统发行版，有效值为 centos，ubuntu，debian，fedora 和 windows 等	No
visibility	String	镜像的可见范围，有效值为 public 和 private	No
provider	String	镜像提供者。初始开·云app官方版下载系统会提供一系列默认镜像，其 provider 为 system 。当用户捕获云服务器后，被捕获的“自有”镜像的 provider 为 self 。参见 CaptureInstance	No
status.n	String	镜像状态: pending, available, deprecated, suspended, deleted, ceased	No
search_word	String	搜索关键词，支持镜像ID，镜像名称	No
verbose	Integer	是否返回冗长的信息，目前 verbose 只支持为 0。	No
offset	Integer	数据偏移量，默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
image_set	Array	JSON 格式的镜像数据列表，每项参数可见下面 Response Item
total_count	Integer	根据过滤条件得到的镜像总数
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

Name	Type	Description
image_id	String	镜像ID
image_name	String	镜像名称
description	String	镜像描述
size	Integer	镜像空间大小，单位为 GB
processor_type	String	镜像支持的处理器类型，有效值为 64位 ( 64bit ) 和 32位 ( 32bit )
platform	String	镜像操作系统平台，有效值为 linux 和 windows
os_family	String	镜像操作系统发行版，有效值为 centos，ubuntu，debian，fedora 和 windows 等
visibility	String	镜像的可见范围，有效值为 public 和 private public: 对所有人可见，例如系统提供的镜像 private: 只对镜像所有者可见，例如用户的自有镜像
provider	String	镜像提供者，有效值为 system 和 self system: 镜像提供者为开·云app官方版下载系统 self: 镜像提供者为用户自己
owner	String	镜像提供者ID
recommended_type	String	运行该镜像的推荐云服务器配置
status	String	镜像状态，有效值为pending, available, deprecated, suspended, deleted, ceased。 pending：等待被创建 available：可用状态，此时可以基于该镜像创建云服务器。 deprecated：已被弃用，此时不再可以基于该镜像创建新的云服务器，但不影响已有云服务器的正常使用。 suspended：由于欠费，已被暂停使用 deleted：已被删除，但处于此状态的镜像在2小时之内仍可以被恢复为 available 状态 ceased：已被彻底删除，处于此状态的镜像无法恢复
transition_status	String	镜像过渡状态，有效值为creating, suspending，resuming，deleting，recovering。 creating：创建中，由 pending 状态变成 available 状态 suspending：欠费暂停中，由 available 状态变成 suspended 状态 resuming：恢复中，由 suspended 状态变成 available 状态 deleting：删除中，由 available/suspended 状态变成 deleted 状态 recovering：恢复中，由 deleted 状态变成 available 状态
create_time	TimeStamp	镜像创建时间，为UTC时间，格式可参见 ISO8601.
status_time	TimeStamp	镜像最近一次状态变更时间，为UTC时间，格式可参见 ISO8601.
tags	String	color：String 类型，标签颜色 tag_id：String 类型，标签 id tag_value：String 类型，标签值 tag_name：String 类型，标签名 owner：String 类型，标签的所有者 tag_key：String 类型，标签键

Example

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeImages
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeImagesResponse",
  "total_count":9,
  "image_set":[
    {
      "status":"ceased",
      "processor_type":"64bit",
      "image_id":"img-37amqany",
      "sub_code":1,
      "transition_status":"",
      "recommended_type":"small_b",
      "image_name":"",
      "visibility":"private",
      "platform":"linux",
      "create_time":"2013-08-07T18:16:32Z",
      "os_family":"centos",
      "provider":"self",
      "owner":"usr-1234abcd",
      "status_time":"2013-08-17T08:16:33Z",
      "tags":[
         { "color":"#c096e0", "tag_id":"tag-rj6nhkn1", "tag_value":"test-tag", "tag_name":"test-tag", "owner":"admin", "tag_key":"test-tag" }
      ],
      "size":20,
      "description":null
    }
  ],
  "ret_code":0
}

Development_docs: DescribeImageUsers

Mon, 01 Jan 0001 00:00:00 +0000

可根据镜像ID, 查询该镜像分享给的用户的列表

如果指定不存在的镜像ID，或非法状态值，则会返回错误信息。

Request Parameters

Parameter name	Type	Description	Required
image_id	String	镜像ID	Yes
offset	Integer	数据偏移量，默认为0	No
limit	Integer	返回数据长度，默认为20	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
image_user_set	Array	JSON 格式的镜像数据列表，每项参数可见下面 Response Item
total_count	Integer	根据过滤条件得到的总数
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

Name	Type	Description
image_id	String	镜像ID
user	Dict	用户的信息 email: 用户的邮箱 user_id: 用户的ID
create_time	TimeStamp	创建时间，为UTC时间，格式可参见 ISO8601.

Example

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeImageUsers&image_id=img-c5hx2ay5
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeImageUsersResponse",
  "image_user_set":[
    {
      "image_id":"img-c5hx2ay5",
      "create_time":"2015-12-10T07:02:52Z",
      "user":{
        "user_id":"usr-kXg2pqJb",
        "email":"steven@gmail.com"
      }
    },
    {
      "image_id":"img-c5hx2ay5",
      "create_time":"2015-12-10T07:14:12Z",
      "user":{
        "user_id":"usr-V9iGGGQB",
        "email":"steven@foxmail.com"
      }
    }
  ],
  "ret_code":0,
  "total_count":2
}

Development_docs: GrantImageToUsers

Mon, 01 Jan 0001 00:00:00 +0000

共享镜像给指定的用户。

Request Parameters

Parameter name	Type	Description	Required
image	String	镜像 ID	Yes
users.n	String	用户id	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=GrantImageToUsers
&image=img-rtyv0968
&user.1=user-1234
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"GrantImageToUsersResponse",
  "ret_code":0
}

Development_docs: ModifyImageAttributes

Mon, 01 Jan 0001 00:00:00 +0000

修改镜像的名称和描述。

修改时不受镜像状态限制。

一次只能修改一个镜像。

Request Parameters

Parameter name	Type	Description	Required
image	String	镜像 ID	Yes
image_name	String	镜像名称	No
description	String	镜像描述	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=ModifyImageAttributes
&image=img-rtyv0968
&image_name=sample
&description=staging_env
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"ModifyImageAttributesResponse",
  "ret_code":0
}

Development_docs: RevokeImageFromUsers

Mon, 01 Jan 0001 00:00:00 +0000

撤销共享给用户。

Request Parameters

Parameter name	Type	Description	Required
image	String	镜像 ID	Yes
users.n	String	用户id	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=RevokeImageFromUsers
&image=img-rtyv0968
&user.1=user-1234
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"RevokeImageFromUsersResponse",
  "ret_code":0
}