全部产品
Search
文档中心

云服务器 ECS:DescribeImagePipelines - 查询镜像模板的详细信息

更新时间:Oct 26, 2026

查询一个或多个镜像模板的详细信息。

接口说明

您可以设置NextToken查询凭证(Token),其取值是上一次调用DescribeImagePipelines返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数进行查询。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeImagePipelines

get

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/*

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

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

cn-hangzhou

ResourceGroupId

string

否

企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明

不支持默认资源组过滤。

rg-bp67acfmxazb4p****

Tag

array<object>

否

标签列表。

object

否

标签列表。

Key

string

否

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

TestKey

Value

string

否

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

TestValue

Name

string

否

模板名称。

testImagePipeline

NextToken

string

否

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

AAAAAdDWBF2****

MaxResults

integer

否

分页查询时每页行数。取值范围:1~500。

默认值:50。

50

ImagePipelineId

array

否

镜像模板 ID。N 取值范围:1~20。

ip-2ze5tsl5bp6nf2b3****

string

否

镜像模板 ID。N 取值范围:1~20。

ip-2ze5tsl5bp6nf2b3****

返回参数

名称

类型

描述

示例值

object

ImagePipeline

object

ImagePipelineSet

array<object>

镜像模板的详细信息组成的列表。

array<object>

AddAccounts

object

AddAccount

array

目标镜像共享的阿里云账号 ID。

string

目标镜像共享的阿里云账号 ID。

["1234567890"]

AdvancedOptions

object

高级设置。

ImageNameSuffix

string

是否禁用目标镜像名称自动增加后缀。可能值:

  • disable:禁用。

disable

RetainCloudAssistant

boolean

是否保留云助手。构建过程中,系统会自动在中转实例中安装云助手以执行命令,您可以选择是否在构建的目标镜像中保留。可能值:

  • true:保留。

  • false:不保留。

说明

该设置不会对您镜像中自带的云助手产生任何影响。

true

BaseImage

string

源镜像。

  • 当BaseImageType=IMAGE时,该参数值为自定义镜像 ID。

  • 当BaseImageType=IMAGE_FAMILY时,该参数值为镜像族系名称。

m-bp67acfmxazb4p****

BaseImageType

string

源镜像类型。可能值:

  • IMAGE:自定义镜像。

  • IMAGE_FAMILY:镜像族系。

IMAGE

BuildContent

string

镜像模板内容。

COMPONENT ic-bp12dvdzvr9k9***** COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*

CreationTime

string

模板创建时间。格式为 ISO 8601,时区为 UTC。

2020-11-24T06:00:00Z

DeleteInstanceOnFailure

boolean

镜像构建失败后是否释放中转实例。

true

Description

string

描述信息。

This is description.

ImageFamily deprecated

string

目标镜像族系。

重要 该参数已弃用。请使用 ImageOptions.ImageFamily。

family

ImageName deprecated

string

目标镜像名称前缀。

重要 该参数已弃用。请使用 ImageOptions.ImageName。

testImageName

ImageOptions

object

目标镜像属性。

Description

string

目标镜像的描述信息。

description.

ImageFamily

string

目标镜像族系。

family

ImageFeatures

object

目标镜像特性相关属性。

NvmeSupport

string

构建的目标镜像是否支持 NVMe。可能值:

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

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

  • auto:自动检测。由系统自动检测您的镜像是否安装 NVMe 驱动,该行为发生在构建阶段前,若您在构建时安装或者卸载了 NVMe 驱动,可能会出现结果偏差,建议您根据构建内容设置为 supported 或 unsupported。

auto

ImageName

string

目标镜像名称前缀。

imageName

ImageTags

object

ImageTag

array<object>

目标镜像标签。

object

TagKey

string

标签键。

testKey

TagValue

string

标签值。

testValue

ImagePipelineId

string

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****

ImageSecurityOptions

object

镜像安全相关属性和设置。

SecurityScanMode

string

安全扫描模式。可能值:

  • agentless :使用云安全无代理检测扫描模式

agentless

ImportImageOptions

object

导入镜像的属性和设置。

Architecture

string

系统架构。取值范围:

  • x86_64。

  • arm64。

x86_64

BootMode

string

导入镜像的启动模式。取值范围:

  • BIOS:BIOS 启动模式。

  • UEFI:UEFI 启动模式。

BIOS

Description

string

导入镜像描述。

created by acc

DiskDeviceMappings

object

DiskDeviceMapping

array<object>

创建的自定义镜像信息列表。

  • N=1 时,表示系统盘.

  • N=2~17 时,表示数据盘。

object

DiskImageSize

integer

导入镜像后,自定义镜像的空间大小。

该空间由系统盘和数据盘组成,您必须保证系统盘的空间大小大于等于导入的镜像文件大小。取值范围:

  • N=1 时,表示系统盘,取值范围:1 GiB~2048 GiB。

  • N=2~17 时,表示数据盘。取值范围:1 GiB~2048 GiB。

当您将源镜像文件上传至 OSS 后,可以在 OSS Bucket 中查看镜像文件的大小。

40

Format

string

镜像格式。取值范围:

  • RAW。

  • VHD。

  • QCOW2。

RAW

OSSBucket

string

镜像文件所在的 OSS Bucket。

ecsimageos

OSSObject

string

镜像上传至 OSS Bucket 后,保存在 Bucket 中的镜像文件的文件名(key)。

CentOS_5.4_32.raw

Features

object

镜像特性相关属性。

ImdsSupport

string

镜像的元数据访问模式,可能值:

  • v1:通过该镜像创建 ECS 实例时,不支持将元数据访问模式设置为“仅加固模式”。

  • v2:通过该镜像创建 ECS 实例时,支持将元数据访问模式设置为“仅加固模式”。

默认值:v1。

v2

NvmeSupport

string

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

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

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

supported

ImageName

string

导入镜像名称。

fvt-ecs-imported-image-1812b2d7

ImportImageTags

object

ImportImageTag

array<object>

导入镜像时使用的标签列表。

object

导入镜像的标签键值对。

Key

string

镜像的标签键。

testKey

Value

string

镜像的标签值。

testValue

LicenseType

string

导入镜像后,激活操作系统采用的许可证类型。取值范围:

  • Auto:由阿里云检测源操作系统并分配许可证。自动模式下,系统优先搜索您设置的Platform是否有阿里云官方渠道的许可证并分配给导入的镜像,如果缺乏该类许可,会切换成 BYOL(Bring Your Own License)方式。

  • Aliyun:根据您设置的Platform采用阿里云官方渠道的许可证。

  • BYOL:源操作系统自带的许可证。采用 BYOL 时,您必须确保您的许可证密钥支持在阿里云使用。

Auto

OSType

string

操作系统类型。可能值:

  • windows。

  • linux。

linux

Platform

string

操作系统版本。取值范围:

  • Aliyun

  • Anolis

  • CentOS

  • Ubuntu

  • CoreOS

  • SUSE

  • Debian

  • OpenSUSE

  • FreeBSD

  • RedHat

  • Kylin

  • UOS

  • Fedora

  • Fedora CoreOS

  • CentOS Stream

  • AlmaLinux

  • Rocky Linux

  • Gentoo

  • Customized Linux

  • Others Linux

  • Windows Server 2022

  • Windows Server 2019

  • Windows Server 2016

  • Windows Server 2012

  • Windows Server 2008

  • Windows Server 2003

  • Other Windows

Aliyun

RetainImportedImage

boolean

重要 该参数已弃用。请使用 ImportImageOptions.RetentionStrategy。

false

RetentionStrategy

string

导入镜像的保留策略。取值范围:

  • RetainOnlySuccessful:构建成功才保留,失败则不保留。

  • RetainOnlyFailed:构建失败才保留,成功则不保留。

  • RetainAlways:无论构建结果如何,总是保留。

  • RetainNever:无论构建结果如何,总是不保留。

默认值:RetainNever

RetainAlways

RoleName

string

导入镜像时,使用的 RAM 角色名称。

AliyunECSImageImportDefaultRole

InstanceType

string

实例规格。

ecs.g6.large

InternetMaxBandwidthOut

integer

中转实例的公网出带宽大小。单位:Mbit/s

0

Name

string

模板名称。

testImagePipeline

NvmeSupport deprecated

string

构建的目标镜像是否支持 NVMe。

重要 该参数已弃用。请使用 ImageOptions. ImageFeatures.NvmeSupport。

auto

RepairItems

object

RepairItem

array

镜像修复项。

  • linux 支持的修复项:
    • fstab:磁盘挂载配置问题修复

    • grub:GRUB 引导配置问题修复

    • dhcp:网络 DHCP 问题修复

    • selinux:Security-Enhanced Linux 问题修复

    • growpart:根分区在线自动扩容问题修复

    • cloudinit:安装 cloud-init 初始化服务

    • aegis:云安全中心 Agent 服务安装

    • nvme:NVMe 驱动问题修复

    • virtio:virtio 驱动问题修复

    • standardizedtimezone:标准化时区问题修复

  • windows 支持的修复项:
    • bcd:启动配置数据文件问题修复

    • hotfix:Windows 补丁问题修复

    • disk:磁盘设置问题修复

    • update:Update 进程问题修复

    • server:服务配置问题修复

    • bootmgr:Windows 启动管理器问题修复

    • vminit:Windows 版初始化 Agent 问题修复

    • osloader:Windows OS Loader 问题修复

    • virtio:virtio 驱动问题修复

    • standardizedtimezone:标准化时区问题修复

string

镜像修复项。

fstab

RepairMode

string

镜像模版中的修复选项。

取值范围:

  • Standard:标准修复模式。

    当前 Linux 系统的标准修复套餐包含

    • GUESTOS.CloudInit

    • GUESTOS.Dhcp

    • GUESTOS.Virtio

    • GUESTOS.OnlineResizeFS

    • GUESTOS.Grub

    • GUESTOS.Fstab

    • GUESTOS.Nvme

    Windows 系统的标准修复套餐包含

    • GUESTOS.Virtio

    • GUESTOS.Update

    • GUESTOS.Hotfix

    • GUESTOS.Server

    • GUESTOS.Bcd

    • GUESTOS.Disk

    • GUESTOS.Bootmgr

    • GUESTOS.OSLoader

    • GUESTOS.Vminit

  • All:全量修复模式。

    当前 Linux 系统的全量修复套餐在标准修复的基础上增加了

    • GUESTOS.Selinux

    • GUESTOS.SecurityCenterAgent

    当前 Windows 系统的全量修复套餐在标准修复的基础上增加了

    • GUESTOS.Server

  • Customized:自定义修复模式。在该模式下,修复套餐中的修复项由 RepairItem 参数来指定。

说明

随着检测修复能力的不断提升,包含的修复项可能会增加。修复项具体含义,请参见镜像检测概述。

Standard

ResourceGroupId

string

企业资源组 ID。

rg-bp67acfmxazb4p****

SystemDiskSize

integer

中转实例的系统盘大小。单位:GiB

40

Tags

object

Tag

array<object>

标签键值对列表。

object

TagKey

string

标签键。

TestKey

TagValue

string

标签值。

TestValue

TestContent

string

镜像测试模板内容。

COMPONENT ic-bp12dvdzvr9k9***** COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*

ToRegionIds

object

ToRegionId

array

目标镜像待分发的地域列表。

string

目标镜像待分发的地域列表。

["cn-hangzhou"]

VSwitchId

string

VPC 的交换机 ID。

vsw-bp67acfmxazb4p****

MaxResults

integer

分页查询时每页行数。

50

NextToken

string

本次调用返回的查询凭证(Token)。具体使用方式请参见接口说明。

AAAAAdDWBF2****

RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

TotalCount

integer

返回的镜像模板数量。

1

示例

正常返回示例

JSON格式

{
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "AdvancedOptions": {
          "ImageNameSuffix": "disable",
          "RetainCloudAssistant": true
        },
        "BaseImage": "m-bp67acfmxazb4p****",
        "BaseImageType": "IMAGE",
        "BuildContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "Description": "This is description.",
        "ImageFamily": "family",
        "ImageName": "testImageName",
        "ImageOptions": {
          "Description": "description.",
          "ImageFamily": "family",
          "ImageFeatures": {
            "NvmeSupport": "auto"
          },
          "ImageName": "imageName",
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey",
                "TagValue": "testValue"
              }
            ]
          }
        },
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "ImageSecurityOptions": {
          "SecurityScanMode": "agentless"
        },
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "BootMode": "BIOS",
          "Description": "created by acc",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "DiskImageSize": 40,
                "Format": "RAW",
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw"
              }
            ]
          },
          "Features": {
            "ImdsSupport": "v2",
            "NvmeSupport": "supported"
          },
          "ImageName": "fvt-ecs-imported-image-1812b2d7",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "testKey",
                "Value": "testValue"
              }
            ]
          },
          "LicenseType": "Auto",
          "OSType": "linux",
          "Platform": "Aliyun",
          "RetainImportedImage": false,
          "RetentionStrategy": "RetainAlways",
          "RoleName": "AliyunECSImageImportDefaultRole"
        },
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "Name": "testImagePipeline",
        "NvmeSupport": "auto",
        "RepairItems": {
          "RepairItem": [
            "fstab"
          ]
        },
        "RepairMode": "Standard",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "VSwitchId": "vsw-bp67acfmxazb4p****"
      }
    ]
  },
  "MaxResults": 50,
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidImagePipelineIdSize.ExceededMaxNumber %s 指定的ImagePipelineId.N数量超过上限,即N超过了上限。N的取值范围:1~20。
400 InvalidName.Malformed %s
403 Invalid.NextToken The specified NextToken is not valid.

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

变更历史

更多信息,参考变更详情。