DescribeImagePipelineExecutions - Elastic Compute Service

Queries the details of an image creation task.

Operation description

Usage notes

The image template that is specified by the ImagePipelineId parameter cannot be a deleted image template. When an image template is deleted, the corresponding image creation task is deleted.
You must specify ImagePipelineId or ExecutionId.
You can configure the query token by using the NextToken parameter. Set NextToken to the value of NextToken that was returned the previous call to the DescribeImagePipelineExecutions operation. Then, use the MaxResults parameter to specify the maximum number of entries to return on each page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecs:DescribeImagePipelineExecutions	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Tag	array<object>	No	Note This parameter is not publicly available.
	object	No	Note This parameter is not publicly available.
Key	string	No	Note This parameter is not publicly available.	null
Value	string	No	Note This parameter is not publicly available.	null
ImagePipelineId	string	No	The ID of the image template.	ip-2ze5tsl5bp6nf2b3****
ExecutionId	string	No	The ID of the image creation task.	exec-5fb8facb8ed7427c****
Status	string	No	The status of the image creation task. You can specify multiple values. Separate the values with commas (,). Example: `BUILDING,DISTRIBUTING`. Valid values: PREPARING: Resources, such as the intermediate instance, are being created. REPAIRING: The source image is being repaired. BUILDING: The user-defined commands are being run and an image is being created. TESTING: The user-defined test commands are being run. DISTRIBUTING: The created image is being copied and shared. RELEASING: The temporary resources generated during the image creation process are being released. SUCCESS: The image creation task is completed. PARTITION_SUCCESS: The image creation task is partially completed. The image is created, but exceptions may occur when the image was copied or shared or when temporary resources were released. FAILED: The image creation task fails. TEST_FAILED: The image is created, but the test fails. CANCELLING: The image creation task is being canceled. CANCELLED: The image creation task is canceled. Note If you leave this parameter empty, all image creation tasks are queried regardless of task status.	BUILDING
NextToken	string	No	The pagination token that is used in the 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****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 500. Default value: 50.	50

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. For information about how to use the returned value, see the "Usage notes" section in this topic.	AAAAAdDWBF2****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of returned image components.	1
MaxResults	integer	The maximum number of entries per page.	50
ImagePipelineExecution	array<object>	Details of the image creation task.
ImagePipelineExecutionSet	object	Details of the image creation task.
CreationTime	string	The time when the image creation task was created.	2020-11-24T06:00:00Z
ImagePipelineId	string	The ID of the image template.	ip-2ze5tsl5bp6nf2b3****
Status	string	The status of the image creation task. Valid values: BUILDING DISTRIBUTING RELEASING SUCCESS FAILED CANCELLING CANCELLED	BUILDING
ModifiedTime	string	The last modification time of the image creation task.	2020-11-25T06:00:00Z
ResourceGroupId	string	The ID of the resource group.	rg-bp67acfmxazb4p****
Message	string	The data returned.	Create transition vpc "vpc-2ze70rc7093j9idu6****" success!
ImageId	string	The ID of the image.	m-bp67acfmxazb4p****
ExecutionId	string	The ID of the image creation task.	exec-5fb8facb8ed7427c****
Tags	array<object>	Note This parameter is not publicly available.
Tag	object	Note This parameter is not publicly available.
TagValue	string	Note This parameter is not publicly available.	null
TagKey	string	Note This parameter is not publicly available.	null

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipelineExecution": {
    "ImagePipelineExecutionSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "Status": "BUILDING",
        "ModifiedTime": "2020-11-25T06:00:00Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Message": "Create transition vpc \"vpc-2ze70rc7093j9idu6****\" success!",
        "ImageId": "m-bp67acfmxazb4p****",
        "ExecutionId": "exec-5fb8facb8ed7427c****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "null",
              "TagKey": "null"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.Status	%s	-
400	MissingParameter.ImagePipelineId	The specified parameter ImagePipelineId should not be empty.	The specified parameter ImagePipelineId should not be empty.
403	Invalid.NextToken	The specified NextToken is not valid.	-
404	InvalidImagePipeline.NotFound	%s	-

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

Change history

Change time	Summary of changes	Operation
2023-04-04	The Error code has changed	View Change Details