All Products
Search
Document Center

Elastic Compute Service:DescribeImagePipelines

Last Updated:Mar 19, 2024

Queries the details of one or more image templates.

Operation description

Description

You can use NextToken to configure the query token. Set the value to the NextToken value that is returned in the last 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

There is currently no authorization information disclosed in the API.

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****
Tagobject []No

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

KeystringNo

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

TestKey
ValuestringNo

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

TestValue
NamestringNo

The name of the image template.

testImagePipeline
NextTokenstringNo

The query token. Set the value to the NextToken value returned in the last call to the DescribeImagePipelines operation. Leave this parameter empty the first time you call this operation.

AAAAAdDWBF2****
MaxResultsintegerNo

The maximum number of entries to return on each page. Valid values: 1 to 500.

Default value: 50.

50
ImagePipelineIdarrayNo

The ID of image template N. 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

The query token returned in this call. For information about how to use this return value, see the "Description" section in this topic.

AAAAAdDWBF2****
RequestIdstring

The ID of the request.

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

The total number of image templates returned.

1
MaxResultsinteger

The maximum number of entries returned per page.

50
ImagePipelineobject []

Details of the image templates.

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 of the intermediate instance.

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.

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

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****
Tagsobject []

The tags of the image template.

TagValuestring

The tag value of the image template.

TestValue
TagKeystring

The tag key of the image template.

TestKey
ToRegionIdsarray

The IDs of regions to which to distribute the created image.

string

The IDs of regions to which to distribute the created image.

["cn-hangzhou"]
AddAccountsarray

The IDs of Alibaba Cloud accounts to which to share the created image.

string

The IDs of Alibaba Cloud accounts to which to share the created image.

["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