DescribeImagePipelineExecutions API reference - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the details of an image build task.

Operation description

The specified image template ID (ImagePipelineId) cannot be a deleted image template. Deleting an image template also deletes the corresponding build tasks.
The image template ID (ImagePipelineId) and the build task ID (ExecutionId) cannot both be empty.
You can set NextToken to the value of NextToken returned in the previous call to DescribeImagePipelineExecutions, and set MaxResults to specify the maximum number of entries per page.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeImagePipelineExecutions

get

*ImagePipelineExecution

acs:ecs:{#regionId}:{#accountId}:imagepipelineexecution/*

*ImagePipelineExecution

acs:ecs:{#regionId}:{#accountId}:imagepipelineexecution/{#ImagePipelineExecutionId}

*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. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
Tag	array<object>	No	The tags.
	object	No	The tag object.
Key	string	No	The tag key. Valid values of N: 1 to 20.	TestKey
Value	string	No	The tag value. Valid values of N: 1 to 20.	TestValue
ImagePipelineId	string	No	The image template ID.	ip-2ze5tsl5bp6nf2b3****
ExecutionId	string	No	The image build task ID.	exec-5fb8facb8ed7427c****
Status	string	No	The status of the image build task. You can specify multiple values at the same time. Separate multiple values with commas (,). Example: `BUILDING,DISTRIBUTING`. Valid values: PREPARING: The task is being prepared. Resources such as temporary intermediate instances are being created. REPAIRING: The source image is being repaired. BUILDING: The task is building. Custom commands are being run and the image is being created. TESTING: The task is being tested. Custom test commands are being run. DISTRIBUTING: The image is being distributed. Image copying and sharing are being performed. RELEASING: Resources are being reclaimed. Temporary resources generated during the build process are being released. SUCCESS: The task succeeded. PARTITION_SUCCESS: The task partially succeeded. The image was built, but exceptions may have occurred during distribution or resource cleanup. FAILED: The task failed to build the image. TEST_FAILED: The test failed. The image was created, but the test failed. CANCELLING: The build process is being canceled. CANCELLED: The build process was canceled. Note If this parameter is empty, image build tasks in all states are queried by default.	BUILDING
NextToken	string	No	The pagination token. Set this parameter to the value of NextToken returned in the previous call. You do not need to set this parameter for the first request.	AAAAAdDWBF2****
MaxResults	integer	No	The maximum number of entries per page for paging. Valid values: 1 to 500. Default value: 50.	50

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token returned in this call. For more information about how to use this token, see the operation description.	AAAAAdDWBF2****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of image components returned.	1
MaxResults	integer	The maximum number of entries per page for paging.	50
ImagePipelineExecution	object
ImagePipelineExecutionSet	array<object>	The details of the image build tasks.
	array<object>	The details of the image build task.
CreationTime	string	The time when the image build task was created. The time is displayed in ISO 8601 format in UTC.	2020-11-24T06:00:00Z
ImagePipelineId	string	The image template ID.	ip-2ze5tsl5bp6nf2b3****
Status	string	The status of the image build task. Valid values: PREPARING: The task is being prepared. Resources such as temporary intermediate instances are being created. REPAIRING: The source image is being repaired. BUILDING: The task is building. Custom commands are being run and the image is being created. TESTING: The task is being tested. Custom test commands are being run. DISTRIBUTING: The image is being distributed. Image copying and sharing are being performed. RELEASING: Resources are being reclaimed. Temporary resources generated during the build process are being released. SUCCESS: The task succeeded. PARTITION_SUCCESS: The task partially succeeded. The image was built, but exceptions may have occurred during distribution or resource cleanup. FAILED: The task failed to build the image. TEST_FAILED: The test failed. The image was created, but the test failed. CANCELLING: The build process is being canceled. CANCELLED: The build process was canceled.	BUILDING
ModifiedTime	string	The time when the task was last updated. The time is displayed in ISO 8601 format in UTC.	2020-11-25T06:00:00Z
ResourceGroupId	string	The resource group ID.	rg-bp67acfmxazb4p****
Message	string	The execution result information.	Create transition vpc "vpc-2ze70rc7093j9idu6****" success!
ImageId	string	The ID of the destination image.	m-bp67acfmxazb4p****
ExecutionId	string	The build task ID.	exec-5fb8facb8ed7427c****
Tags	object
Tag	array<object>	The tags.
	object	The tag object.
TagValue	string	The tag value.	TestKey
TagKey	string	The tag key.	TestValue
ErrorCode	string	The error code returned when an execution error occurs.	NO_AVAILABLE_INSTANCE_TYPE
ErrorInfo	string	The error message returned when an execution error occurs.	No available instance type to use.

Examples

Success response

JSON format

{
  "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": "TestKey",
              "TagKey": "TestValue"
            }
          ]
        },
        "ErrorCode": "NO_AVAILABLE_INSTANCE_TYPE",
        "ErrorInfo": "No available instance type to use."
      }
    ]
  }
}

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.
400	InvalidExecutionId.SizeExceeded	ExecutionId list exceeds maximum size of %s. Current size is %s.	The ExecutionId list size you set exceeds the maximum allowed.
403	Invalid.NextToken	The specified NextToken is not valid.
404	InvalidImagePipeline.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.