All Products
Search
Document Center

Elastic Compute Service:DescribeImagePipelines

Last Updated:Sep 29, 2024

Queries the information about 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeImagePipelinesget
  • ImagePipeline
    acs:ecs:{#regionId}:{#accountId}:imagepipeline/*
  • ImagePipeline
    acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the image template. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceGroupIdstringNo

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****
Tagarray<object>No

The tags of the image template.

objectNo

The value of tag N of the image template. Valid values of N: 1 to 20.

KeystringNo

The key of tag N. Valid values of N: 1 to 20.

TestKey
ValuestringNo

The value of tag N. Valid values of N: 1 to 20.

TestValue
NamestringNo

The name of the image template.

testImagePipeline
NextTokenstringNo

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

AAAAAdDWBF2****
MaxResultsintegerNo

The number of entries per page. Valid values: 1 to 500.

Default value: 50.

50
ImagePipelineIdarrayNo

The IDs of image templates. Valid values of N: 1 to 20.

stringNo

The ID of image template N. Valid values of N: 1 to 20.

ip-2ze5tsl5bp6nf2b3****

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. For information about how to use the return value, see the "Usage notes" section of this topic.

AAAAAdDWBF2****
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

The total number of image templates returned.

1
MaxResultsinteger

The number of entries per page.

50
ImagePipelinearray<object>

Details about the image templates.

ImagePipelineSetobject
CreationTimestring

The time when the image template was created.

2020-11-24T06:00:00Z
DeleteInstanceOnFailureboolean

Indicates whether to release the intermediate instance when the image fails to be created.

true
InstanceTypestring

The instance type.

ecs.g6.large
InternetMaxBandwidthOutinteger

The size of the outbound public bandwidth for the intermediate instance. Unit: Mbit/s.

0
ImagePipelineIdstring

The ID of the image template.

ip-2ze5tsl5bp6nf2b3****
VSwitchIdstring

The ID of the vSwitch in the virtual private cloud (VPC).

vsw-bp67acfmxazb4p****
SystemDiskSizeinteger

The system disk size of the intermediate instance. Unit: GiB

40
Descriptionstring

The description of the image template.

This is description.
BaseImagestring

The source image.

  • When BaseImageType is set to IMAGE, the value of this parameter is the ID of a custom image.
  • When BaseImageType is set to IMAGE_FAMILY, the value of this parameter is the name of an image family.
m-bp67acfmxazb4p****
ResourceGroupIdstring

The ID of the resource group.

rg-bp67acfmxazb4p****
ImageNamestring

The name prefix of the image to be created based on the image template.

testImageName
BaseImageTypestring

The type of the source image. Valid values:

  • IMAGE: custom image
  • IMAGE_FAMILY: image family
IMAGE
Namestring

The name of the image template.

testImagePipeline
BuildContentstring

The content of the image template.

FROM IMAGE:m-bp67acfmxazb4p****
Tagsarray<object>

The tags of the image template.

Tagobject
TagValuestring

The value of the tag.

TestValue
TagKeystring

The key of the tag.

TestKey
ToRegionIdsarray

The IDs of regions to which to distribute the image that will be created based on the image template.

ToRegionIdstring

The ID of the region to which to distribute the image that will be created based on the image template.

["cn-hangzhou"]
AddAccountsarray

The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template.

AddAccountstring

The ID of the Alibaba Cloud account to which to share the image that will be created based on the image template.

["1234567890"]

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\"]"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidImagePipelineIdSize.ExceededMaxNumber%sThe number of specified ImagePipelineId.N parameters exceeds the upper limit. Valid values of N: 1 to 20.
400InvalidName.Malformed%s-
403Invalid.NextTokenThe specified NextToken is not valid.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history