文档

DescribeImageFromFamily - 查询镜像族系内可用镜像

更新时间:

调用DescribeImageFromFamily查询指定镜像族系内最新创建的可用自定义镜像。

接口说明

指定查询的镜像族系如果不存在可用的镜像,则返回结果为空。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeImageFromFamilyRead
  • Image
    acs:ecs:{#regionId}:{#accountId}:image/*

请求参数

名称类型必填描述示例值
RegionIdstring

镜像所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ImageFamilystring

镜像族系名称。

自定义镜像、公共镜像、社区镜像、共享镜像均已支持镜像族系,使用方法及介绍请参见镜像族系概述

hangzhou-daily-update

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Imageobject

返回的镜像信息。

CreationTimestring

镜像的创建时间。

2018-01-10T01:01:10Z
Statusstring

镜像的状态。可能值:

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

镜像族系。

testImageFamily
Progressstring

镜像完成的进度,单位为百分比。

100
IsCopiedboolean

是否是复制的镜像。

false
IsSupportIoOptimizedboolean

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

true
ImageOwnerAliasstring

镜像所有者别名。可能值:

  • system:公共镜像。
  • self:您的自定义镜像。
  • others:其他用户的公开镜像。
  • marketplace:云市场镜像。
self
IsSupportCloudinitboolean

是否支持 cloud-init。

true
ImageVersionstring

镜像版本。

2
Usagestring

有引用关系的资源类型。可能值:

  • instance:创建了一台或多台 ECS 实例。
  • none:未创建过 ECS 实例。
none
IsSelfSharedstring

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

true
Descriptionstring

描述信息。

testDescription
Sizeinteger

镜像大小,单位 GiB。

80
Platformstring

操作系统平台。

Aliyun
ImageNamestring

镜像的名称。

testImageName
OSNamestring

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

Alibaba Cloud Linux 2.1903
ImageIdstring

镜像 ID。

m-bp1g7004ksh0oeuc****
OSTypestring

操作系统类型。可能值:

  • windows
  • linux
linux
IsSubscribedboolean

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

false
ProductCodestring

镜像市场的镜像商品标示。

jxsc00****
Architecturestring

镜像系统架构类型。可能值:

  • i386
  • x86_64
x86_64
DiskDeviceMappingsobject []

镜像下包含云盘和快照的映射关系。

Typestring

镜像的类型。

custom
ImportOSSBucketstring

导入镜像所属 OSS 的 Bucket。

testEcsImport
SnapshotIdstring

快照 ID。

s-bp17ot2q7x72ggtw****
ImportOSSObjectstring

导入镜像所属 OSS 的 Object。

imageImport
Sizestring

云盘大小,单位 GiB。

80
Devicestring

云盘的设备信息,例如/dev/xvdb。

说明 该参数即将停止使用,为提高代码的兼容性,建议您尽量不要使用该参数。
/dev/xvdb
Formatstring

镜像格式。

qcow2
Tagsobject []

镜像的标签对信息。

TagValuestring

自定义镜像的标签值。

TestValue
TagKeystring

自定义镜像的标签键。

TestKey

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Image": {
    "CreationTime": "2018-01-10T01:01:10Z",
    "Status": "Available",
    "ImageFamily": "testImageFamily",
    "Progress": "100",
    "IsCopied": false,
    "IsSupportIoOptimized": true,
    "ImageOwnerAlias": "self",
    "IsSupportCloudinit": true,
    "ImageVersion": "2",
    "Usage": "none",
    "IsSelfShared": "true",
    "Description": "testDescription",
    "Size": 80,
    "Platform": "Aliyun",
    "ImageName": "testImageName",
    "OSName": "Alibaba Cloud Linux 2.1903",
    "ImageId": "m-bp1g7004ksh0oeuc****",
    "OSType": "linux",
    "IsSubscribed": false,
    "ProductCode": "jxsc00****",
    "Architecture": "x86_64",
    "DiskDeviceMappings": {
      "DiskDeviceMapping": [
        {
          "Type": "custom",
          "ImportOSSBucket": "testEcsImport",
          "SnapshotId": "s-bp17ot2q7x72ggtw****",
          "ImportOSSObject": "imageImport",
          "Size": "80",
          "Device": "/dev/xvdb",
          "Format": "qcow2"
        }
      ]
    },
    "Tags": {
      "Tag": [
        {
          "TagValue": "TestValue",
          "TagKey": "TestKey"
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
403InvalidUser.UnauthorizedThe user is not authorized.您当前使用的账号无权限。
404InvalidRegionId.NotFoundThe RegionId provided does not exist.指定的地域不存在,请确认该参数是否正确。

访问错误中心查看更多错误码。

  • 本页导读 (1)