帮助文档 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
帮助文档 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 云服务器 ECS
  4. 开发参考
  5. API参考(ECS)
  6. API目录
  7. 镜像
  8. DescribeImagePipelineExecutions - 查询一个镜像构建任务的详细信息

DescribeImagePipelineExecutions - 查询一个镜像构建任务的详细信息

  • 镜像
  • 发布于 2025-04-01
  • 0 次阅读
文档编辑
文档编辑

调用DescribeImagePipelineExecutions查询一个镜像构建任务的详细信息。

接口说明

  • 指定的镜像模板 IDImagePipelineId不能是已删除的镜像模板,已删除的镜像模板会同步删除对应的构建任务。
  • 镜像模板 IDImagePipelineId和构建任务 IDExecutionId不能同时为空。
  • 您可以设置NextToken查询凭证(Token),其取值是上一次调用DescribeImagePipelineExecutions返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数进行查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring是

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
Tagarray<object>否

标签列表。

object否

标签对象。

Keystring否

标签键。N 的取值范围:1~20。

TestKey
Valuestring否

标签值。N 的取值范围:1~20。

TestValue
ImagePipelineIdstring否

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****
ExecutionIdstring否

镜像构建任务 ID。

exec-5fb8facb8ed7427c****
Statusstring否

镜像构建任务的状态。支持同时设置多个值,每个值之间以半角逗号(,)间隔,格式示例为BUILDING,DISTRIBUTING。取值范围:

  • PREPARING:准备中。创建临时中转实例等资源。
  • REPAIRING:修复中。修复源镜像。
  • BUILDING:构建中。执行用户自定义命令以及创建镜像。
  • TESTING:测试中。执行用户自定义测试命令。
  • DISTRIBUTING:分发中。执行镜像复制以及共享。
  • RELEASING:资源回收中。构建过程中生成的临时资源。
  • SUCCESS:成功。构建成功。
  • PARTITION_SUCCESS:部分成功。镜像已构建成功,但可能在分发或者资源清理等步骤出现了异常。
  • FAILED:失败。构建镜像失败。
  • TEST_FAILED:测试失败。镜像创建成功,但测试失败。
  • CANCELLING:取消中。正在取消构建流程。
  • CANCELLED:已取消。构建流程已取消。
说明 当参数值为空时,默认查询所有状态的镜像构建任务
BUILDING
NextTokenstring否

查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。

AAAAAdDWBF2****
MaxResultsinteger否

分页查询时每页行数。取值范围:1~500。

默认值:50。

50

返回参数

名称类型描述示例值
object
NextTokenstring

本次调用返回的查询凭证(Token)。具体使用方式请参见接口说明。

AAAAAdDWBF2****
RequestIdstring

请求 ID。

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

返回的镜像组件数量。

1
MaxResultsinteger

分页查询时每页行数。

50
ImagePipelineExecutionarray<object>

镜像构建任务的详细信息组成的列表。

ImagePipelineExecutionSetobject

镜像构建任务的详细信息组成的列表。

CreationTimestring

镜像构建任务的创建时间。

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

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****
Statusstring

镜像构建任务的状态。可能值:

  • PREPARING:准备中。创建临时中转实例等资源。
  • REPAIRING:修复中。修复源镜像。
  • BUILDING:构建中。执行用户自定义命令以及创建镜像。
  • TESTING:测试中。执行用户自定义测试命令。
  • DISTRIBUTING:分发中。执行镜像复制以及共享。
  • RELEASING:资源回收中。构建过程中生成的临时资源。
  • SUCCESS:成功。构建成功。
  • PARTITION_SUCCESS:部分成功。镜像已构建成功,但可能在分发或者资源清理等步骤出现了异常。
  • FAILED:失败。构建镜像失败。
  • TEST_FAILED:测试失败。镜像创建成功,但测试失败。
  • CANCELLING:取消中。正在取消构建流程。
  • CANCELLED:已取消。构建流程已取消。
BUILDING
ModifiedTimestring

任务最近一次更新的时间。

2020-11-25T06:00:00Z
ResourceGroupIdstring

企业资源组 ID。

rg-bp67acfmxazb4p****
Messagestring

执行结果信息。

Create transition vpc "vpc-2ze70rc7093j9idu6****" success!
ImageIdstring

目标镜像 ID。

m-bp67acfmxazb4p****
ExecutionIdstring

构建任务 ID。

exec-5fb8facb8ed7427c****
Tagsarray<object>

标签列表。

Tagobject

标签对象。

TagValuestring

标签值。

TestKey
TagKeystring

标签键。

TestValue

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.Status%s-
400MissingParameter.ImagePipelineIdThe specified parameter ImagePipelineId should not be empty.参数ImagePipelineId不为空。
403Invalid.NextTokenThe specified NextToken is not valid.-
404InvalidImagePipeline.NotFound%s-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-12-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-04-04OpenAPI 错误码发生变更查看变更详情
相关文章

CancelCopyImage - 取消正在进行中的复制镜像任务 2025-04-01 11:58

取消正在进行中的复制镜像(CopyImage)任务。 接口说明

CancelImagePipelineExecution - 取消一个镜像构建任务 2025-04-01 11:58

取消一个镜像构建任务。 接口说明

CopyImage - 复制一个地域下的自定义镜像到其他地域 2025-04-01 11:58

复制一个地域下的自定义镜像到其他地域。复制镜像可以实现跨地域部署ECS实例、跨地域复制ECS实例等目的。

CreateImage - 创建自定义镜像 2025-04-01 11:58

创建一份自定义镜像。后续您可以使用创建的自定义镜像创建ECS实例(RunInstances),或者更换实例的系统盘(ReplaceSystemDisk)。

CreateImageComponent - 创建一个镜像组件 2025-04-01 11:58

创建一个镜像组件。镜像组件用于存储您在构建镜像时,常用的构建模板命令。

CreateImagePipeline - 创建镜像构建模板 2025-04-01 11:58

创建一个镜像模板。镜像模板可用于构建镜像。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 博智数字服务平台.
闽ICP备08105208号-1