云主机

  • 云主机服务 > API 文档 > 镜像 >镜像列表

    镜像列表

    最近更新时间:2020-12-29 16:04:35

    请求路径

    GET /v1/vm/image

    请求参数

    名称 类型 位置 必须 描述
    page integer query

    页码。默认:1

    size integer query

    分页大小,最大 100。默认 20

    region_id string query

    地域 ID。

    您可以调用 DescribeRegions 查看最新的七牛云地域列表。

    image_owner_alias string query

    镜像来源。取值范围:

    • system :七牛云提供的公共镜像。
    • self :您创建的自定义镜像。
    • others :其他七牛云用户共享给您的镜像。
    • marketplace :镜像市场提供的镜像。您查询到的云市场镜像可以直接使用,无需提前订阅。您需要自行留意云市场镜像的收费详情。 默认值:空,空表示返回取值为 system、self 以及 others 的结果。
    image_id string query

    镜像 ID。

    image_name string query

    镜像名称。

    长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以 http://https:// 开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

    默认值:空

    instance_id string query

    实例 ID

    os_name string query

    操作系统的中文显示名称。

    返回值

    名称 类型 描述
    total integer 镜像数量
    page integer 页码
    size integer 分页大小
    request_id string 请求 ID
    data []Image 镜像列表

    Image

    名称 类型 描述
    cost_charge_type string

    付费方式

    cost_charge_mode string

    计费方式

    region_id string

    实例所属的地域 ID。

    created_at string

    创建时间

    updated_at string

    更新时间

    instance_id string

    实例 ID

    instance_name string

    实例名称

    image_id string

    镜像 ID

    image_name string

    镜像的名称

    description string

    镜像描述

    os_type string

    操作系统类型。可能值:windows, linux

    os_name string

    操作系统的中文显示名称。

    architecture string

    镜像的体系架构。取值范围:i386, x86_64

    image_owner_alias string

    镜像来源。取值范围:

    • system :七牛云提供的公共镜像。
    • self :您创建的自定义镜像。
    • others :其他七牛云用户共享给您的镜像。
    • marketplace :镜像市场提供的镜像。您查询到的云市场镜像可以直接使用,无需提前订阅。您需要自行留意云市场镜像的收费详情。
    progress string 镜像完成的进度,单位为百分比。
    usage string

    镜像是否已经运行在 ECS 实例中。取值范围:

    • instance:镜像处于运行状态,有 ECS 实例使用。
    • none:镜像处于闲置状态,暂无 ECS 实例使用。
    image_version string

    镜像版本

    status string

    镜像的状态。可能值:

    • UnAvailable:不可用
    • Available:可用
    • Creating:创建中
    • CreateFailed:创建失败
    is_self_shared string

    是否共享过该自定义镜像给其他用户

    platform string

    操作系统平台

    size integer

    镜像大小,单位 GiB

    is_support_cloudinit boolean

    是否支持 Cloud Init

    is_support_io_optimized boolean

    是否可以在 I/O 优化实例上运行

    is_copied boolean

    是否是拷贝的镜像

    is_subscribed boolean

    是否订阅了该镜像的商品码对应的镜像商品的服务条款

    snapshot_id string

    根据某一快照 ID 创建的自定义镜像

    min_disk_size string

    镜像要求的最小系统盘盘容量

    返回值示例

    {
      "data": [
        {
          "region_id": "grand-cn-southwest-2",
          "created_at": "2020-12-14T18:14:17.248+08:00",
          "updated_at": "2020-12-14T18:14:47.078+08:00",
          "image_id": "0ab29702-015d-404e-b51f-026c0b5f3518",
          "description": "",
          "product_code": "",
          "os_type": "linux",
          "architecture": "",
          "os_name": "M-lGBib",
          "image_owner_alias": "self",
          "progress": "100%",
          "usage": "",
          "image_version": "CentOS 8.0 64bit",
          "status": "Available",
          "image_name": "M-lGBib",
          "is_self_shared": "False",
          "platform": "CentOS",
          "size": 2,
          "is_support_cloudinit": false,
          "is_support_io_optimized": false,
          "is_copied": true,
          "is_subscribed": false,
          "disk_device_mappings": null,
          "snapshot_id": "3df4161c-656f-4636-8695-704437d4fd3d",
          "min_disk_size": "",
          "instance_id": "d29c254c-def9-4af0-8541-200616f5c06c",
          "instance_name": "test_hw_guizhou",
          "cost_charge_type": "PostPaid",
          "cost_charge_mode": "PayByDisk"
        }
      ],
      "page": 1,
      "size": 10,
      "total": 18,
      "request_id": "N8cGF3EvRnQOSFMW"
    }
    
    以上内容是否对您有帮助?
  • Qvm free helper
    Close