Queries the details of one or more image templates.
Operation description
You can use NextToken to configure the query token. Set the value to the NextToken value that is returned in the previous call to the DescribeImagePipelines operation. Then, use MaxResults to specify the maximum number of entries to return on each page.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeImagePipelines | get | *ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/**ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the image template. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ResourceGroupId | string | No | The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. Note
Resources in the default resource group are displayed in the response regardless of how this parameter is set.
| rg-bp67acfmxazb4p**** |
| Tag | array<object> | No | The tags of the image template. | |
| object | No | The value of tag N of the image template. Valid values of N: 1 to 20. | ||
| Key | string | No | The key of tag N. Valid values of N: 1 to 20. | TestKey |
| Value | string | No | The value of tag N. Valid values of N: 1 to 20. | TestValue |
| Name | string | No | The name of the image template. | testImagePipeline |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of | AAAAAdDWBF2**** |
| MaxResults | integer | No | The maximum number of entries per page. Valid values: 1 to 500. Default value: 50. | 50 |
| ImagePipelineId | array | No | The IDs of image templates. Valid values of N: 1 to 20. | |
| string | No | The ID of image template N. Valid values of N: 1 to 20. | ip-2ze5tsl5bp6nf2b3**** |
Response parameters
Examples
Sample success responses
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": "FROM IMAGE:m-bp67acfmxazb4p****",
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"ToRegionIds": {
"ToRegionId": [
"[\"cn-hangzhou\"]"
]
},
"AddAccounts": {
"AddAccount": [
"[\"1234567890\"]"
]
},
"RepairMode": "null",
"TestContent": "null",
"ImageFamily": "null",
"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,
"ImageNameSuffix": "disable"
},
"ImageOptions": {
"ImageName": "imageName",
"ImageFamily": "family",
"Description": "description.",
"ImageFeatures": {
"NvmeSupport": "auto"
},
"ImageTags": {
"ImageTag": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
]
}
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidImagePipelineIdSize.ExceededMaxNumber | %s | The number of specified ImagePipelineId.N parameters exceeds the upper limit. Valid values of N: 1 to 20. |
| 400 | InvalidName.Malformed | %s | - |
| 403 | Invalid.NextToken | The specified NextToken is not valid. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-02-28 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2025-01-13 | API Description Update. The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-12-17 | API Description Update. The Error code has changed | View Change Details |
| 2024-10-10 | The Error code has changed. The response structure of the API has changed | View Change Details |