详情页标题前

阿里云ECS云服务器DescribeImages-云淘科技

详情页1

调用DescribeImages查询您可以使用镜像资源。

接口说明

  • 您可以查询的镜像资源包括您的自定义镜像、阿里云提供的公共镜像、云市场镜像以及其他阿里云用户主动共享给您的共享镜像。
  • 支持分页查询,查询结果包括可使用的镜像资源的总数和当前页的镜像资源。每页的数量默认为10条。
  • 通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见CLI参数格式说明。
  • 当查询阿里云官方提供的镜像或共享镜像(ImageOwnerAlias指定system或others)时,本次请求可忽略RAM鉴权规则。更多信息,请参见鉴权规则。

调试

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

请求参数

名称

类型

必选

示例值

描述

Action String DescribeImages

系统规定参数。取值:DescribeImages

RegionId String cn-hangzhou

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

Status String Available

查询指定状态的镜像,如果不配置此参数,默认只返回Available状态的镜像。取值范围:

  • Creating:镜像正在创建中。
  • Waiting:多任务排队中。
  • Available(默认):您可以使用的镜像。
  • UnAvailable:您不能使用的镜像。
  • CreateFailed:创建失败的镜像。
  • Deprecated:已弃用的镜像。

默认值:Available。当前参数支持同时取多个值,值之间以半角逗号(,)隔开。

ImageId String m-bp1g7004ksh0oeuc****

镜像ID。

ShowExpired Boolean false

订阅型镜像是否已经超过使用期限。

说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。

SnapshotIdStrings-bp17ot2q7x72ggtw****

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

ImageName String testImageName

镜像名称。

ImageFamily String hangzhou-daily-update

镜像族系名称,查询镜像时可通过设置该参数来过滤当前族系对应的镜像。

默认值:空。

说明 阿里云官方镜像关联的镜像族系信息请参见公共镜像概述。

ImageOwnerAliasStringself

镜像来源。取值范围:

  • system:阿里云官方提供的,且不是通过云市场发布的镜像,和控制台中的“公共镜像”概念不同。
  • self:您创建的自定义镜像。
  • others:包含共享镜像(其他阿里云用户直接共享给您的镜像)和社区镜像(任意阿里云用户将其自定义镜像完全公开共享后的镜像)。您需要注意:
    • 查找社区镜像时,IsPublic必须为true。
    • 查找共享镜像时,IsPublic需要设置为false或者不传值。
  • marketplace:阿里云或者第三方供应商ISV在云市场发布的镜像,需要和ECS一起购买。请自行留意云市场镜像的收费详情。

默认值:空。

说明 空表示返回取值为system、self以及others的结果。

InstanceTypeStringecs.g5.large

指定实例类型可以使用的镜像。

IsSupportIoOptimized Boolean true

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

IsSupportCloudinit Boolean true

镜像是否支持cloud-init。

OSType String linux

镜像的操作系统类型。取值范围:

  • windows。
  • linux。
Architecture String i386

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

  • i386。
  • x86_64。
  • arm64。
PageNumber Integer 1

镜像资源列表的页码。

起始值:1。

默认值:1。

PageSize Integer 1

分页查询时设置的每页行数。

最大值:100。

默认值:10。

Usage String instance

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

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

是否只预检此次请求。

  • true:发送检查请求,不会查询资源状况。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation。
  • false:发送正常请求,通过检查后返回2XX HTTP状态码并直接查询资源状况。

默认值:false。

ActionType String CreateEcs

镜像需要被使用到的场景。取值范围:

  • CreateEcs(默认):创建实例。
  • ChangeOS:更换系统盘/更换操作系统。
ResourceGroupId String rg-bp67acfmxazb4p****

自定义镜像所在的企业资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。

说明 不支持默认资源组过滤。

Tag.N.keyStringnull

镜像的标签键。

说明 该参数即将被弃用,为提高兼容性,建议您使用另一个Tag.N.Key参数。

Tag.N.KeyStringTestKey

镜像的标签键。N的取值范围:1~20。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,请使用ListTagResources接口进行查询。

Tag.N.Value String TestValue

镜像的标签值。N的取值范围:1~20。

Tag.N.value String null

镜像的标签值。

说明 该参数即将被弃用,为提高兼容性,建议您使用另一个Tag.N.Value参数。

Filter.N.KeyStringCreationStartTime

查询资源时的筛选键。取值范围:

  • 当该参数取值为CreationStartTime时,可以查询在指定时间点(Filter.N.Value)后创建的资源信息。
  • 当该参数取值为CreationEndTime时,可以查询在指定时间点(Filter.N.Value)前创建的资源信息。
Filter.N.Value String 2017-12-05T22:40Z

查询资源时的筛选值。指定该参数时必须同时指定Filter.N.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用UTC+0时区。

IsPublic Boolean false

是否查询已发布的社区镜像。取值范围:

  • true:查询已发布的社区镜像。当您指定该参数值为true时,ImageOwnerAlias必须为others。
  • false:查询除社区镜像的其他镜像类型,具体以ImageOwnerAlias参数值为准。

默认值:false。

ImageOwnerId Long 1234567890

镜像所属的阿里云账号ID。该参数仅在查询共享镜像以及社区镜像时生效。

返回数据

名称

类型

示例值

描述

PageSize Integer 1

当前分页包含多少条目。

PageNumber Integer 1

当前页码。

RequestId String 66189103-EDB2-43E2-BB60-BFF2B62F4EB8

请求ID。

TotalCount Integer 1

镜像总数。

RegionId String cn-hangzhou

镜像所属地域ID。

Images Array of Image

镜像信息Images组成的集合。

Image
CreationTime String 2019-11-15T06:07:05Z

镜像的创建时间。

Status String Available

镜像的状态。可能值:

  • UnAvailable:不可用。
  • Available:可用。
  • Creating:创建中。
  • CreateFailed:创建失败。
ImageFamily String hangzhou-daily-update

镜像族系名称。

Progress String 100%

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

IsCopied Boolean false

是否是拷贝的镜像。

IsSupportIoOptimized Boolean true

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

ImageOwnerAlias String self

镜像来源。可能值:

  • system:阿里云提供的公共镜像。
  • self:您创建的自定义镜像。
  • others:其他阿里云用户提供的共享镜像或社区镜像。
  • marketplace:云市场镜像提供的镜像。
IsSupportCloudinit Boolean true

是否支持Cloud Init。

ImageVersion String 2

镜像版本。

Usage String none

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

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

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

Description String Archive log for Oracle

描述信息。

Size Integer 60

镜像大小,单位:GiB。

ResourceGroupId String rg-bp67acfmxazb4p****

镜像所在的企业资源组ID。

Platform String Windows Server 2016

操作系统平台。

OSNameEn String Windows Server 2016 Data Center Edition 64bit Chinese Edition

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

ImageName String testImageName

镜像的名称。

OSName String Windows Server 2016 数据中心版 64位中文版

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

ImageId String m-bp1g7004ksh0oeuc****

镜像ID。

OSType String windows

操作系统类型。可能值:

  • windows。
  • linux。
IsSubscribed Boolean false

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

ProductCode String test000****

云市场镜像中的镜像商品标识。

Architecture String x86_64

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

  • i386。
  • x86_64。
  • arm64。
BootMode String BIOS

修改镜像的启动模式。可能值:

  • BIOS:BIOS启动模式。
  • UEFI:UEFI启动模式。
DiskDeviceMappings Array of DiskDeviceMapping

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

DiskDeviceMapping
Type String system

镜像的类型。

ImportOSSBucket String testEcsImport

导入镜像所属OSS的bucket。

Progress String 32%

对于复制中的镜像,返回复制任务的进度。

SnapshotId String s-bp17ot2q7x72ggtw****

快照ID。

ImportOSSObject String imageImport

导入镜像所属OSS的object。

Device String /dev/xvda

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

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

SizeString60

云盘的大小。单位为GiB。

RemainTime Integer 233

对于复制中的镜像,返回复制任务的剩余时间,单位:秒。

Format String qcow2

镜像格式。

Tags Array of Tag

镜像的标签对信息。

Tag
TagValue String Oracle

镜像的标签值。

TagKey String DTS

镜像的标签键。

IsPublic Boolean false

是否为公开镜像。公开镜像包括阿里云提供的公共镜像以及您已发布为社区镜像的自定义镜像。可能值:

  • true:公开镜像。
  • false:非公开镜像。
ImageOwnerId Long 1234567890

镜像所属的阿里云账号ID。该参数仅在查询共享镜像以及社区镜像时生效。

LoginAsNonRootSupported Boolean false

当前镜像是否支持非root用户登录。可能值:

  • true:支持。
  • false:不支持。
SupplierName String TestName

社区镜像认证企业名称。

DetectionOptions Object

镜像检测相关结果。

Status String Processing

镜像检测任务状态。可能值:

  • Processing:检测中。
  • Finished:检测完成。
Items Array of Item

镜像检测项列表。

Item
Name String Nvme

镜像检测项名称。

Value String Supported

镜像检测项结果。

RiskLevel String High

导入的自定义镜像检测项是否存在风险,如果存在风险返回此字段,不存在风险则不返回。

风险等级可能值:

  • High:严重,影响实例能否启动成功,强烈建议修复。
  • Medium:重要,影响实例启动性能或者实例配置等,建议优化。
RiskCode String NVMe.NotInstalled

检测项可能存在的缺陷。

Features Object

镜像特性相关属性。

NvmeSupport String supported

镜像是否支持NVMe。可能值:

  • supported:支持。表示以该镜像创建的实例支持NVMe协议。
  • unsupported:不支持。表示以该镜像创建的实例不支持NVMe协议。

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml


    1
    1
    66189103-EDB2-43E2-BB60-BFF2B62F4EB8
    1
    
        
            self
            true
            Archive log for Oracle
            Windows Server 2016
            rg-bp67acfmxazb4p****
            60
            false
            BIOS
            Windows Server 2016 数据中心版 64位中文版
            false
            m-bp1g7004ksh0oeuc****
            
            
                supported
            
            Windows Server 2016 Data Center Edition 64bit Chinese Edition
            
                
                    DTS
                    Oracle
                
            
            false
            Available
            100%
            none
            x86_64
            test000****
            false
            hangzhou-daily-update
            true
            true
            testImageName
            
                
                    s-bp17ot2q7x72ggtw****
                    system
                    32%
                    qcow2
                    /dev/xvda
                    60
                    testEcsImport
                    imageImport
                
            
            2
            windows
            2019-11-15T06:07:05Z
        
    
    cn-hangzhou

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 1,
  "RequestId" : "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
  "PageNumber" : 1,
  "Images" : {
    "Image" : [ {
      "ImageOwnerAlias" : "self",
      "IsSelfShared" : "true",
      "Description" : "Archive log for Oracle",
      "Platform" : "Windows Server 2016",
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "Size" : 60,
      "IsSubscribed" : false,
      "BootMode" : "BIOS",
      "OSName" : "Windows Server 2016 数据中心版 64位中文版",
      "IsPublic" : false,
      "ImageId" : "m-bp1g7004ksh0oeuc****",
      "DetectionOptions" : { },
      "Features" : {
        "NvmeSupport" : "supported"
      },
      "OSNameEn" : "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "DTS",
          "TagValue" : "Oracle"
        } ]
      },
      "LoginAsNonRootSupported" : false,
      "Status" : "Available",
      "Progress" : "100%",
      "Usage" : "none",
      "Architecture" : "x86_64",
      "ProductCode" : "test000****",
      "IsCopied" : false,
      "ImageFamily" : "hangzhou-daily-update",
      "IsSupportIoOptimized" : true,
      "IsSupportCloudinit" : true,
      "ImageName" : "testImageName",
      "DiskDeviceMappings" : {
        "DiskDeviceMapping" : [ {
          "SnapshotId" : "s-bp17ot2q7x72ggtw****",
          "Type" : "system",
          "Progress" : "32%",
          "Format" : "qcow2",
          "Device" : "/dev/xvda",
          "Size" : "60",
          "ImportOSSBucket" : "testEcsImport",
          "ImportOSSObject" : "imageImport"
        } ]
      },
      "ImageVersion" : "2",
      "OSType" : "windows",
      "CreationTime" : "2019-11-15T06:07:05Z"
    } ]
  },
  "RegionId" : "cn-hangzhou"
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidImageOwnerAlias.ValueNotSupported The specified ImageOwnerAlias value is not supported. 无效的镜像所有者别名,请您检查该参数是否正确。
400 InvalidParamter Invalid Parameter. 输入的参数无效。
400 InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 指定的 Tag.N.Key 和 Tag.N.Value 不匹配。
400 InvalidTagCount The specified tags are beyond the permitted range. 指定的标记超出取值范围。
400 InvalidInstanceType.ValueNotSupported The specified InstanceType does not exist or beyond the permitted range. 您指定的实例规格不存在,或者您没有权限操作此规格的实例。
403 CurrentAccount.NotSupportPublicImage Public image is not supported for current account. 当前用户不支持使用公共镜像。
404 InvalidFilterKey.NotFound The specified Filter Key is not found. Filter的Key参数无效。
404 InvalidFilterValue The specified Filter Value is not valid. Filter中的Value无效。
404 InvalidUsage The specified Usage is not valid. Usage参数无效。
404 InvalidOSType The specified OSType is not valid. OSType参数无效。
404 InvalidArchitecture The specified Architecture is not valid. Architecture参数无效。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。

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

腾讯云1折,限时活动,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠

转转请注明出处:https://www.yunxiaoer.com/151425.html

(0)
上一篇 2023年12月9日 下午4:44
下一篇 2023年12月9日
详情页2

相关推荐

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。