Mengkueri informasi terperinci dari satu atau lebih templat image.
Deskripsi operasi
Anda dapat mengatur token kueri NextToken, yang nilainya adalah nilai NextToken yang dikembalikan pada pemanggilan sebelumnya ke DescribeImagePipelines. Kemudian, atur MaxResults untuk menentukan jumlah maksimum entri per halaman untuk kueri.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeImagePipelines |
get |
*ImagePipeline
*ImagePipeline
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID region. Anda dapat memanggil DescribeRegions untuk mengkueri daftar region terbaru. |
cn-hangzhou |
| ResourceGroupId |
string |
No |
ID grup sumber daya enterprise. Saat Anda menggunakan parameter ini untuk memfilter sumber daya, jumlah sumber daya tidak boleh melebihi 1.000. Catatan
Grup sumber daya default tidak didukung untuk pemfilteran. |
rg-bp67acfmxazb4p**** |
| Tag |
array<object> |
No |
Daftar tag. |
|
|
object |
No |
Daftar tag. |
||
| Key |
string |
No |
Kunci tag. Nilai N yang valid: 1 hingga 20. |
TestKey |
| Value |
string |
No |
Nilai tag. Nilai N yang valid: 1 hingga 20. |
TestValue |
| RegionId |
string |
Yes |
ID region. Anda dapat memanggil DescribeRegions untuk mengkueri daftar region terbaru. |
cn-hangzhou |
| ResourceGroupId |
string |
No |
ID grup sumber daya enterprise. Saat Anda menggunakan parameter ini untuk memfilter sumber daya, jumlah sumber daya tidak boleh melebihi 1.000. Catatan
Grup sumber daya default tidak didukung untuk pemfilteran. |
rg-bp67acfmxazb4p**** |
| Name |
string |
No |
Nama templat image. |
testImagePipeline |
| NextToken |
string |
No |
Token kueri. Atur nilainya ke nilai |
AAAAAdDWBF2**** |
| MaxResults |
integer |
No |
Jumlah entri per halaman. Nilai yang valid: 1 hingga 500. Nilai default: 50. |
50 |
| ImagePipelineId |
array |
No |
ID templat image. Nilai N yang valid: 1 hingga 20. |
ip-2ze5tsl5bp6nf2b3**** |
|
string |
No |
ID templat image. Nilai N yang valid: 1 hingga 20. |
ip-2ze5tsl5bp6nf2b3**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| NextToken |
string |
Token kueri yang dikembalikan dalam pemanggilan ini. Untuk informasi lebih lanjut tentang cara menggunakan token, lihat deskripsi operasi ini. |
AAAAAdDWBF2**** |
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
Jumlah templat image yang dikembalikan. |
1 |
| MaxResults |
integer |
Jumlah entri per halaman. |
50 |
| ImagePipeline |
object |
||
| ImagePipelineSet |
array<object> |
Daftar informasi terperinci tentang templat image. |
|
|
array<object> |
|||
| CreationTime |
string |
The time when the image template was created. |
2020-11-24T06:00:00Z |
| DeleteInstanceOnFailure |
boolean |
Indicates whether to release the intermediate instance when the image fails to be created. |
true |
| InstanceType |
string |
The instance type. |
ecs.g6.large |
| InternetMaxBandwidthOut |
integer |
The size of the outbound public bandwidth for the intermediate instance. Unit: Mbit/s. |
0 |
| ImagePipelineId |
string |
The ID of the image template. |
ip-2ze5tsl5bp6nf2b3**** |
| VSwitchId |
string |
The ID of the vSwitch in the virtual private cloud (VPC). |
vsw-bp67acfmxazb4p**** |
| SystemDiskSize |
integer |
The system disk size of the intermediate instance. Unit: GiB |
40 |
| Description |
string |
The description of the image template. |
This is description. |
| BaseImage |
string |
The source image.
|
m-bp67acfmxazb4p**** |
| ResourceGroupId |
string |
The ID of the resource group. |
rg-bp67acfmxazb4p**** |
ImageName
deprecated
|
string |
The name prefix of the image created based on the image template. Catatan
This parameter is no longer used. We recommend that you use ImageOptions.ImageName. |
testImageName |
| BaseImageType |
string |
The type of the source image. Valid values:
|
IMAGE |
| Name |
string |
The name of the image template. |
testImagePipeline |
| BuildContent |
string |
The content of the image template. |
COMPONENT ic-bp12dvdzvr9k9***** COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.* |
| Tags |
object |
||
| Tag |
array<object> |
The tags of the image template. |
|
|
object |
|||
| TagValue |
string |
The value of the tag. |
TestValue |
| TagKey |
string |
The key of the tag. |
TestKey |
| ToRegionIds |
object |
||
| ToRegionId |
array |
The IDs of regions to which to distribute the image that will be created based on the image template. |
|
|
string |
The ID of the region to which to distribute the image that will be created based on the image template. |
["cn-hangzhou"] |
|
| AddAccounts |
object |
||
| AddAccount |
array |
The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template. |
|
|
string |
The ID of the Alibaba Cloud account to which to share the image that will be created based on the image template. |
["1234567890"] |
|
| RepairMode |
string |
The repair mode of the image template. Valid values:
|
Standard |
| TestContent |
string |
The content of the image test template. |
COMPONENT ic-bp12dvdzvr9k9***** COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.* |
ImageFamily
deprecated
|
string |
The family of the image created based on the image template. Catatan
This parameter is no longer used. We recommend that you use ImageOptions.ImageFamily. |
family |
NvmeSupport
deprecated
|
string |
Indicates whether the image created based on the image template supports the Non-Volatile Memory Express (NVMe) protocol. Catatan
This parameter is no longer used. We recommend that you use ImageOptions.ImageFeatures.NvmeSupport. |
auto |
| ImportImageOptions |
object |
The attributes and settings of the imported image. |
|
| Architecture |
string |
The operating system architecture. Valid values:
|
x86_64 |
| OSType |
string |
The operating system type. Valid values:
|
linux |
| Platform |
string |
The version of the operating system. Valid values:
|
Aliyun |
| BootMode |
string |
The boot mode of the image. Valid values:
|
BIOS |
| LicenseType |
string |
The type of the license to use to activate the operating system after the image is imported. Valid values:
|
Auto |
| DiskDeviceMappings |
object |
||
| DiskDeviceMapping |
array<object> |
The information of disks from which the custom images are created.
|
|
|
object |
|||
| OSSBucket |
string |
The Object Storage Service (OSS) bucket where the image file is stored. |
ecsimageos |
| OSSObject |
string |
The name (key) of the object that the image file is stored as in the OSS bucket. |
CentOS_5.4_32.raw |
| Format |
string |
The format of the image. Valid values:
|
RAW |
| DiskImageSize |
integer |
The size of disk N in the custom image after the image is imported. You can use this parameter to specify the sizes of the system disk and data disks in the custom image. When you specify the size of the system disk, make sure that the specified size is greater than or equal to the size of the source image file. Unit: GiB. Valid values:
After the image file is uploaded to an OSS bucket, you can view the size of the image file in the OSS bucket. |
40 |
| Features |
object |
The attributes of the custom image. |
|
| NvmeSupport |
string |
Indicates whether the image supports the NVMe protocol. Valid values:
|
supported |
| ImdsSupport |
string |
||
| RetainImportedImage |
boolean |
Catatan
This parameter is in invitational preview. |
false |
| RetentionStrategy |
string |
||
| ImageName |
string |
||
| Description |
string |
||
| RoleName |
string |
||
| ImportImageTags |
object |
||
| ImportImageTag |
array<object> |
||
|
object |
|||
| Key |
string |
||
| Value |
string |
||
| AdvancedOptions |
object |
The advanced settings. |
|
| RetainCloudAssistant |
boolean |
Indicates whether to retain Cloud Assistant. During the image building process, the system automatically installs Cloud Assistant in the intermediate instance to run commands. You can choose whether to retain Cloud Assistant in the new image created based on the image template. Valid values:
Catatan
This parameter does not affect Cloud Assistant that comes with your image. |
true |
| ImageNameSuffix |
string |
Indicates whether to disable the feature that automatically adds a suffix to the name of the image created based on the image template. Valid value:
|
disable |
| ImageOptions |
object |
The attributes of the image created based on the image template. |
|
| ImageName |
string |
The prefix of the image name. |
imageName |
| ImageFamily |
string |
The image family. |
family |
| Description |
string |
The description of the image. |
description. |
| ImageFeatures |
object |
The feature attributes of the image. |
|
| NvmeSupport |
string |
Indicates whether the image supports the NVMe protocol. Valid values:
|
auto |
| ImageTags |
object |
||
| ImageTag |
array<object> |
The tags of the image. |
|
|
object |
|||
| TagKey |
string |
The tag key of the image. |
testKey |
| TagValue |
string |
The tag value of the image. |
testValue |
Contoh
Respons sukses
JSONformat
{
"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",
"ImdsSupport": ""
},
"RetainImportedImage": false,
"RetentionStrategy": "",
"ImageName": "",
"Description": "",
"RoleName": "",
"ImportImageTags": {
"ImportImageTag": [
{
"Key": "",
"Value": ""
}
]
}
},
"AdvancedOptions": {
"RetainCloudAssistant": true,
"ImageNameSuffix": "disable"
},
"ImageOptions": {
"ImageName": "imageName",
"ImageFamily": "family",
"Description": "description.",
"ImageFeatures": {
"NvmeSupport": "auto"
},
"ImageTags": {
"ImageTag": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
]
}
}
}
]
}
}Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidImagePipelineIdSize.ExceededMaxNumber | %s | |
| 400 | InvalidName.Malformed | %s | |
| 403 | Invalid.NextToken | The specified NextToken is not valid. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.