You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeImages

最近更新时间：2023.08.01 17:11:36

首次发布时间：2021.07.31 07:48:16

我的收藏

调用 DescribeImages 接口查询镜像信息。

说明

调用该接口时，使用TagFilters.N.Key和TagFilters.N.Values.N查询到的镜像数量不能超过1000个。若超过1000个，请使用 DesribeTags 接口进行查询。

请求参数

名称类型是否必填示例值
描述
ActionString是DescribeImages要执行的操作，取值：DescribeImages。
VersionString是2020-04-01接口的版本，取值：2020-04-01。
ImageNameString否test镜像名称。
NextTokenString否-分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

否

15

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

  • 取值范围：1 ~ 100
  • 默认值：15

ImageIds.N

String

否

ImageIds.1=image-3tksv4n6ay3vj0******& ImageIds.2=image-2asdv4n6ay3vj0******

镜像的ID，最多支持100个ID。您可以调用CreateImage、ImportImage接口获取自定义镜像ID，或调用本接口查询获取。

  • 参数 - N：表示镜像ID的序号
  • 多个镜像ID之间用&分隔

OsType

String

否

Linux

操作系统类型。取值：

  • Linux
  • Windows

Visibility

String

否

public

镜像的可见性。取值：

  • public：公共镜像
  • private：自定义镜像
  • shared：共享镜像
InstanceTypeIdString否ecs.c1.xlarge实例的规格ID，传入本参数时，将返回该规格可用的镜像ID列表。

IsSupportCloudInit

Boolean

否

true

镜像是否支持Cloud-init。取值：

  • true：支持
  • false：不支持

Status.N

String

否

Status.1=available&Status.2=creating

镜像状态，最多支持10个。取值：

  • available（默认）：可用
  • creating：创建中
  • error：错误

说明

  • 参数 - N：表示镜像状态的序号
  • 多个镜像状态之间用&分隔
ProjectNameString否default资源所属项目。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1

镜像标签的标签键。

  • 参数 - N：表示标签键的序号。
  • 取值范围：1～10，多个标签键之间用&分隔。
  • 不允许重复。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

镜像标签的标签值。

  • 第一个N：表示标签键的序号，取值范围：1～10。
  • 第二个N：表示标签值的序号，同一标签键最多支持同时查询3个标签值。取值范围：1～3。
  • 多个标签值之间用&分隔。

说明

  • 如果传入该参数，则必须先传入TagFilters.N.Key。
  • 不传则表示查询同一标签键下的所有标签值。
  • 传入空字符串时，表示查询标签值为空的标签。

返回数据

名称类型示例值描述
NextTokenStringbHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******本次调用返回的查询凭证值，返回为空表示没有下一页。
ImagesArray of struct-镜像信息。具体请参见下表“Images 结构”。

Images 结构

名称类型示例值描述
ImageIdStringimage-3tksv4n6ay3vj******镜像ID。
ImageNameStringtest镜像名称。
DescriptionStringtestdescription镜像描述。
OsTypeStringLinux操作系统类型。
StatusStringavailable镜像的状态。
VisibilityStringpublic镜像的可见性。

Architecture

String

amd64

镜像的架构类型。取值：

  • amd64：x86计算
  • arm64：ARM计算
UpdatedAtString2021-07-26T21:55:12+08:00更新时间，格式满足RFC3339。
CreatedAtString2021-07-26T21:55:12+08:00创建时间，格式满足RFC3339。

Platform

String

CentOS

镜像操作系统的发行版本。取值：

  • CentOS
  • Debian
  • veLinux
  • Windows Server
  • Fedora
  • OpenSUSE
  • Ubuntu
PlatformVersionString7.6镜像的发行版本。
OsNameStringCentOS 7.6 64位镜像操作系统的名称。

IsSupportCloudInit

Boolean

true

镜像是否支持Cloud-init。取值：

  • true：支持
  • false：不支持

ShareStatus

String

-

镜像共享状态。取值：

  • HasShared：自定义镜像已被共享给其他用户。
  • 当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
SizeInteger20镜像大小，单位为GiB。
ImageOwnerIdString210005****镜像所属的账号ID。该参数仅在查询共享镜像时生效。
ProjectNameStringdefault资源所属项目。
BootModeStringUEFI镜像的启动模式。
TagsArray of struct-镜像的标签信息，具体请参见下表“ Tags 结构 ”。

Tags 结构

名称类型示例值描述
KeyStringimage-tag-key-1镜像的标签键。
ValueStringimage-tag-value-1镜像的标签值。

请求示例

GET /?Action=DescribeImages&Version=2020-04-01&MaxResults=1 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021110417394001022514606307*****",
        "Action":"DescribeImages",
        "Version":"2020-04-01",
        "Service":"ecs",
        "Region":"cn-beijing"
    },
    "Result":{
        "NextToken":"",
        "Images":[
            {
                "ImageId":"image-ebgy1og99tfct0gw****",
                "ImageName":"Windows Server 2012 R2 数据中心版 64位中文版",
                "Description":"testdescription",
                "OsType":"Windows",
                "Platform":"Windows Server",
                "PlatformVersion":"2012 R2 Datacenter Edition 64-bit Chinese",
                "Status":"available",
                "Visibility":"public",
                "Architecture":"amd64",
                "UpdatedAt":"2021-11-09T14:51:40+08:00",
                "CreatedAt":"2021-11-09T14:24:55+08:00",
                "OsName":"Windows Server 2012 R2 Datacenter Edition 64-bit Chinese",
                "IsSupportCloudInit":true,
                "ShareStatus":"",
                "Size":20,
                "ImageOwnerId":"210005****",
                "ProjectName":"default",
                "BootMode":"UEFI",
                "Tags": [
                  {
                    "Key": "image-tag-key-1",
                    "Value": "image-tag-value-1"
                  }
                ]
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidOsType.MalformedThe specified OsType is malformed.指定的操作系统不合法。
400InvalidVisibility.MalformedThe specified Visibility is malformed.指定的可见性不合法。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400LimitExceeded.MaximumImageIdsYou've reached the limit on the number of ImageIds that you can set.指定的镜像ID数量超过限制。
400LimitExceeded.MaximumStatusYou've reached the limit on the number of Status that you can set.指定的镜像状态数量超过限制。
400LimitExceeded.MaximumTagFilterKeysYou've reached the limit on the number of TagFilterKeys that you can set.指定的标签键超过最大限制。
400LimitExceeded.MaximumTagFilterValuesYou've reached the limit on the number of TagFilterValues that you can set.指定的标签值超过最大限制。
400InvalidTagFilterKey.MalformedThe specified TagFilterKey is malformed.指定的标签键不合法。
400InvalidTagFilterValue.MalformedThe specified TagFilterValue is malformed.指定的标签值不合法。
400LimitExceeded.MaximumTagFilterResultsYou've reached the limit on the number of resources that you can describe by TagFilters.通过标签过滤出的资源数量超过上限。
404InvalidInstanceType.NotFoundThe specified InstanceType does not exist.指定的实例规格不存在。
409InvalidTagFilterKey.ConflictThe specified TagFilterKey already exists.指定的标签键已存在。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。