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

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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。
	string	否	镜像模板 ID。N 取值范围：1~20。	ip-2ze5tsl5bp6nf2b3****

返回参数

名称	类型	描述	示例值
	object
NextToken	string	本次调用返回的查询凭证（Token）。具体使用方式请参见接口说明。	AAAAAdDWBF2****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返回的镜像模板数量。	1
MaxResults	integer	分页查询时每页行数。	50
ImagePipeline	array<object>	镜像模板的详细信息组成的列表。
ImagePipelineSet	object
CreationTime	string	模板创建时间。	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	镜像构建失败后是否释放中转实例。	true
InstanceType	string	实例规格。	ecs.g6.large
InternetMaxBandwidthOut	integer	中转实例的公网出带宽大小。单位：Mbit/s	0
ImagePipelineId	string	镜像模板 ID。	ip-2ze5tsl5bp6nf2b3****
VSwitchId	string	VPC 的交换机 ID。	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	中转实例的系统盘大小。单位：GiB	40
Description	string	描述信息。	This is description.
BaseImage	string	源镜像。当`BaseImageType=IMAGE`时，该参数值为自定义镜像 ID。当`BaseImageType=IMAGE_FAMILY`时，该参数值为镜像族系名称。	m-bp67acfmxazb4p****
ResourceGroupId	string	企业资源组 ID。	rg-bp67acfmxazb4p****
ImageName	string	目标镜像名称前缀。	testImageName
BaseImageType	string	源镜像类型。可能值： IMAGE：自定义镜像。 IMAGE_FAMILY：镜像族系。	IMAGE
Name	string	模板名称。	testImagePipeline
BuildContent	string	镜像模板内容。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
Tags	array<object>	标签键值对列表。
Tag	object
TagValue	string	标签值。	TestValue
TagKey	string	标签键。	TestKey
ToRegionIds	array	目标镜像待分发的地域列表。
ToRegionId	string	目标镜像待分发的地域列表。	["cn-hangzhou"]
AddAccounts	array	目标镜像共享的阿里云账号 ID。
AddAccount	string	目标镜像共享的阿里云账号 ID。	["1234567890"]
RepairMode	string	镜像模版中的修复选项。取值范围： Standard：标准模式。	Standard
TestContent	string	镜像测试模板内容。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily	string	目标镜像族系。	family
NvmeSupport	string	构建的目标镜像是否支持 NVMe。可能值： supported：支持。表示以该镜像创建的实例支持 NVMe 协议。 unsupported：不支持。表示以该镜像创建的实例不支持 NVMe 协议。 auto：自动检测。由系统自动检测您的镜像是否安装 NVMe 驱动，该行为发生在构建阶段前，若您在构建时安装或者卸载了 NVMe 驱动，可能会出现结果偏差，建议您根据构建内容设置为 supported 或 unsupported。	auto
ImportImageOptions	object	导入镜像的属性和设置。
Architecture	string	系统架构。取值范围： x86_64。 arm64。	x86_64
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
BootMode	string	导入镜像的启动模式。取值范围： BIOS：BIOS 启动模式。 UEFI：UEFI 启动模式。	BIOS
LicenseType	string	导入镜像后，激活操作系统采用的许可证类型。取值范围： Auto：由阿里云检测源操作系统并分配许可证。自动模式下，系统优先搜索您设置的`Platform`是否有阿里云官方渠道的许可证并分配给导入的镜像，如果缺乏该类许可，会切换成 BYOL（Bring Your Own License）方式。 Aliyun：根据您设置的`Platform`采用阿里云官方渠道的许可证。 BYOL：源操作系统自带的许可证。采用 BYOL 时，您必须确保您的许可证密钥支持在阿里云使用。	Auto
DiskDeviceMappings	array<object>	创建的自定义镜像信息列表。 N=1 时，表示系统盘. N=2~17 时，表示数据盘。
DiskDeviceMapping	object
OSSBucket	string	镜像文件所在的 OSS Bucket。	ecsimageos
OSSObject	string	镜像上传至 OSS Bucket 后，保存在 Bucket 中的镜像文件的文件名（key）。	CentOS_5.4_32.raw
Format	string	镜像格式。取值范围： RAW。 VHD。 QCOW2。	RAW
DiskImageSize	integer	导入镜像后，自定义镜像的空间大小。该空间由系统盘和数据盘组成，您必须保证系统盘的空间大小大于等于导入的镜像文件大小。取值范围： N=1 时，表示系统盘，取值范围：1 GiB~2048 GiB。 N=2~17 时，表示数据盘。取值范围：1 GiB~2048 GiB。当您将源镜像文件上传至 OSS 后，可以在 OSS Bucket 中查看镜像文件的大小。	40
Features	object	镜像特性相关属性。
NvmeSupport	string	导入的镜像是否支持 NVMe。可能值： supported：支持。表示以该镜像创建的实例支持 NVMe 协议。 unsupported：不支持。表示以该镜像创建的实例不支持 NVMe 协议。	supported
RetainImportedImage	boolean	是否保留导入的镜像。导入完成后，系统会自动删除导入的原始镜像，防止为您带来不必要的存储计费，您也可以选择是否保留。可能值： true：保留。若导入完成，即使取消构建或者构建失败也不会删除。 false：不保留。	false
AdvancedOptions	object	高级设置。
RetainCloudAssistant	boolean	是否保留云助手。构建过程中，系统会自动在中转实例中安装云助手以执行命令，您可以选择是否在构建的目标镜像中保留。可能值： true：保留。 false：不保留。说明该设置不会对您镜像中自带的云助手产生任何影响。	true

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "VSwitchId": "vsw-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Description": "This is description.",
        "BaseImage": "m-bp67acfmxazb4p****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ImageName": "testImageName",
        "BaseImageType": "IMAGE",
        "Name": "testImagePipeline",
        "BuildContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ImageFamily": "family",
        "NvmeSupport": "auto",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux",
          "Platform": "Aliyun",
          "BootMode": "BIOS",
          "LicenseType": "Auto",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw",
                "Format": "RAW",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported"
          },
          "RetainImportedImage": false
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true
        }
      }
    ]
  }
}

错误码

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.	-

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

变更历史

变更时间	变更内容概要	操作
2025-01-13	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-12-17	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2024-10-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情