查询一个或多个镜像模板的详细信息。
接口说明
您可以设置NextToken查询凭证（Token），其取值是上一次调用DescribeImagePipelines返回的NextToken参数值，再通过MaxResults设置单页查询的最大条目数进行查询。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeImagePipelines |
get |
*ImagePipeline
*ImagePipeline
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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）。取值为上一次调用该接口返回的 |
AAAAAdDWBF2**** |
| MaxResults |
integer |
否 |
分页查询时每页行数。取值范围：1~500。 默认值：50。 |
50 |
| ImagePipelineId |
array |
否 |
镜像模板 ID。N 取值范围：1~20。 |
ip-2ze5tsl5bp6nf2b3**** |
|
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 |
object |
||
| ImagePipelineSet |
array<object> |
镜像模板的详细信息组成的列表。 |
|
|
array<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 |
源镜像。
|
m-bp67acfmxazb4p**** |
| ResourceGroupId |
string |
企业资源组 ID。 |
rg-bp67acfmxazb4p**** |
ImageName
deprecated
|
string |
目标镜像名称前缀。 重要
该参数已弃用。请使用 ImageOptions.ImageName。
|
testImageName |
| BaseImageType |
string |
源镜像类型。可能值：
|
IMAGE |
| Name |
string |
模板名称。 |
testImagePipeline |
| BuildContent |
string |
镜像模板内容。 |
COMPONENT ic-bp12dvdzvr9k9***** COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.* |
| Tags |
object |
||
| Tag |
array<object> |
标签键值对列表。 |
|
|
object |
|||
| TagValue |
string |
标签值。 |
TestValue |
| TagKey |
string |
标签键。 |
TestKey |
| ToRegionIds |
object |
||
| ToRegionId |
array |
目标镜像待分发的地域列表。 |
|
|
string |
目标镜像待分发的地域列表。 |
["cn-hangzhou"] |
|
| AddAccounts |
object |
||
| AddAccount |
array |
目标镜像共享的阿里云账号 ID。 |
|
|
string |
目标镜像共享的阿里云账号 ID。 |
["1234567890"] |
|
| RepairMode |
string |
镜像模版中的修复选项。 取值范围：
说明
随着检测修复能力的不断提升，包含的修复项可能会增加。修复项具体含义，请参见镜像检测概述。 |
Standard |
| RepairItems |
object |
||
| RepairItem |
array |
镜像修复项。
|
|
|
string |
|||
| TestContent |
string |
镜像测试模板内容。 |
COMPONENT ic-bp12dvdzvr9k9***** COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.* |
ImageFamily
deprecated
|
string |
目标镜像族系。 重要
该参数已弃用。请使用 ImageOptions.ImageFamily。
|
family |
NvmeSupport
deprecated
|
string |
构建的目标镜像是否支持 NVMe。 重要
该参数已弃用。请使用 ImageOptions. ImageFeatures.NvmeSupport。
|
auto |
| ImportImageOptions |
object |
导入镜像的属性和设置。 |
|
| Architecture |
string |
系统架构。取值范围：
|
x86_64 |
| OSType |
string |
操作系统类型。可能值：
|
linux |
| Platform |
string |
操作系统版本。取值范围：
|
Aliyun |
| BootMode |
string |
导入镜像的启动模式。取值范围：
|
BIOS |
| LicenseType |
string |
导入镜像后，激活操作系统采用的许可证类型。取值范围：
|
Auto |
| DiskDeviceMappings |
object |
||
| DiskDeviceMapping |
array<object> |
创建的自定义镜像信息列表。
|
|
|
object |
|||
| OSSBucket |
string |
镜像文件所在的 OSS Bucket。 |
ecsimageos |
| OSSObject |
string |
镜像上传至 OSS Bucket 后，保存在 Bucket 中的镜像文件的文件名（key）。 |
CentOS_5.4_32.raw |
| Format |
string |
镜像格式。取值范围：
|
RAW |
| DiskImageSize |
integer |
导入镜像后，自定义镜像的空间大小。 该空间由系统盘和数据盘组成，您必须保证系统盘的空间大小大于等于导入的镜像文件大小。取值范围：
当您将源镜像文件上传至 OSS 后，可以在 OSS Bucket 中查看镜像文件的大小。 |
40 |
| Features |
object |
镜像特性相关属性。 |
|
| NvmeSupport |
string |
导入的镜像是否支持 NVMe。可能值：
|
supported |
| ImdsSupport |
string |
镜像的元数据访问模式，可能值：
默认值：v1。 |
v2 |
| RetainImportedImage |
boolean |
重要
该参数已弃用。请使用 ImportImageOptions.RetentionStrategy。
|
false |
| RetentionStrategy |
string |
导入镜像的保留策略。取值范围：
默认值：RetainNever |
RetainAlways |
| ImageName |
string |
导入镜像名称。 |
fvt-ecs-imported-image-1812b2d7 |
| Description |
string |
导入镜像描述。 |
created by acc |
| RoleName |
string |
导入镜像时，使用的 RAM 角色名称。 |
AliyunECSImageImportDefaultRole |
| ImportImageTags |
object |
||
| ImportImageTag |
array<object> |
||
|
object |
|||
| Key |
string |
镜像的标签键。 |
testKey |
| Value |
string |
镜像的标签值。 |
testValue |
| AdvancedOptions |
object |
高级设置。 |
|
| RetainCloudAssistant |
boolean |
是否保留云助手。构建过程中，系统会自动在中转实例中安装云助手以执行命令，您可以选择是否在构建的目标镜像中保留。可能值：
说明
该设置不会对您镜像中自带的云助手产生任何影响。 |
true |
| ImageNameSuffix |
string |
是否禁用目标镜像名称自动增加后缀。可能值：
|
disable |
| ImageOptions |
object |
目标镜像属性。 |
|
| ImageName |
string |
目标镜像名称前缀。 |
imageName |
| ImageFamily |
string |
目标镜像族系。 |
family |
| Description |
string |
目标镜像的描述信息。 |
description. |
| ImageFeatures |
object |
目标镜像特性相关属性。 |
|
| NvmeSupport |
string |
构建的目标镜像是否支持 NVMe。可能值：
|
auto |
| ImageTags |
object |
||
| ImageTag |
array<object> |
目标镜像标签。 |
|
|
object |
|||
| TagKey |
string |
标签键。 |
testKey |
| TagValue |
string |
标签值。 |
testValue |
示例
正常返回示例
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",
"RepairItems": {
"RepairItem": [
""
]
},
"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",
"ImdsSupport": "v2"
},
"RetainImportedImage": false,
"RetentionStrategy": "RetainAlways",
"ImageName": "fvt-ecs-imported-image-1812b2d7",
"Description": "created by acc",
"RoleName": "AliyunECSImageImportDefaultRole",
"ImportImageTags": {
"ImportImageTag": [
{
"Key": "testKey",
"Value": "testValue"
}
]
}
},
"AdvancedOptions": {
"RetainCloudAssistant": true,
"ImageNameSuffix": "disable"
},
"ImageOptions": {
"ImageName": "imageName",
"ImageFamily": "family",
"Description": "description.",
"ImageFeatures": {
"NvmeSupport": "auto"
},
"ImageTags": {
"ImageTag": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
]
}
}
}
]
}
}错误码
|
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. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。