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

Call DescribeImagePipelineExecutions to get details about an image build task.

Operation description

API

The ImagePipelineId cannot refer to a deleted image pipeline. Deleting an image pipeline also deletes its associated build tasks.
The ImagePipelineId and ExecutionId parameters cannot both be empty.
To paginate the results, set NextToken to the value returned by the previous call to DescribeImagePipelineExecutions. Use MaxResults to specify the maximum number of results 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 the DescribeRegions operation to query the latest list of Alibaba Cloud regions.	cn-hangzhou
Tag	array<object>	No	The list of tags.
	object	No	A tag object.
Key	string	No	The key of tag N. The value of N can be from 1 to 20.	TestKey
Value	string	No	The value of tag N. The value of N can be from 1 to 20.	TestValue
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the latest list of Alibaba Cloud regions.	cn-hangzhou
ImagePipelineId	string	No	The ID of the image template.	ip-2ze5tsl5bp6nf2b3****
ExecutionId	string	No	The ID of the image building task.	exec-5fb8facb8ed7427c****
Status	string	No	The status of the image building task. You can specify multiple values, separated by commas. Example: `BUILDING,DISTRIBUTING`. Valid values: PREPARING: The system is preparing resources, such as a temporary transit instance. REPAIRING: The system is repairing the source image. BUILDING: The system is building the image. This includes executing user-defined commands and creating the image. TESTING: The system is testing the created image by running user-defined test commands. DISTRIBUTING: The system is distributing the image. This includes copying and sharing the image. RELEASING: The system is releasing temporary resources generated during the build process. SUCCESS: The task completed successfully. PARTITION_SUCCESS: The task is partially successful. The image was created, but an error may have occurred during distribution or resource cleanup. FAILED: The image building task failed. TEST_FAILED: The image was created successfully, but it failed the user-defined tests. CANCELLING: The system is canceling the image building task. CANCELLED: The image building task was canceled. Note If you omit this parameter, the operation returns image building tasks of all statuses.	BUILDING
NextToken	string	No	The query token. Set the value to the `NextToken` value returned from a previous call to this operation. This parameter is not required for the first call.	AAAAAdDWBF2****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 500. Default value: 50.	50

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token returned in this call. Use this token to retrieve the next page of results. For more information, see the operation description.	AAAAAdDWBF2****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of image pipeline executions.	1
MaxResults	integer	The number of entries per page.	50
ImagePipelineExecution	object	The details of the image pipeline executions.
ImagePipelineExecutionSet	array<object>	The image pipeline executions.
	array<object>	Details of an image pipeline execution.
CreationTime	string	The time when the image pipeline execution was created.	2020-11-24T06:00:00Z
ImagePipelineId	string	The ID of the image pipeline.	ip-2ze5tsl5bp6nf2b3****
Status	string	The status of the image pipeline execution. Valid values: `PREPARING`: The system prepares for the execution, such as creating temporary resources like a transit instance. `REPAIRING`: The system is repairing the source image. `BUILDING`: The system is building the image. This process includes running custom commands and creating the image. `TESTING`: The image is being tested by running custom test commands. `DISTRIBUTING`: The system is distributing the image, which includes copying and sharing it. `RELEASING`: Temporary resources for the execution are being released. `SUCCESS`: The execution is successful. `PARTITION_SUCCESS`: The execution is partially successful. The image was created, but errors may have occurred in subsequent steps, such as image distribution or resource cleanup. `FAILED`: The execution failed. `TEST_FAILED`: The image was created, but the tests failed. `CANCELLING`: The execution is being canceled. `CANCELLED`: The execution is canceled.	BUILDING
ModifiedTime	string	The time when the execution was last updated.	2020-11-25T06:00:00Z
ResourceGroupId	string	The ID of the resource group.	rg-bp67acfmxazb4p****
Message	string	The message associated with the execution.	Create transition vpc "vpc-2ze70rc7093j9idu6****" success!
ImageId	string	The ID of the destination image.	m-bp67acfmxazb4p****
ExecutionId	string	The ID of the execution.	exec-5fb8facb8ed7427c****
Tags	object	The tags.
Tag	array<object>	A list of tags.
	object	The tag object.
TagValue	string	The tag value.	TestKey
TagKey	string	The tag key.	TestValue
ErrorCode	string	The error code for a failed execution.	NO_AVAILABLE_INSTANCE_TYPE
ErrorInfo	string	The error message for a failed execution.	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.