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

更新时间:
复制为 MD 格式

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

接口说明

接口说明

  • 指定的镜像模板 IDImagePipelineId不能是已删除的镜像模板,已删除的镜像模板会同步删除对应的构建任务。

  • 镜像模板 IDImagePipelineId和构建任务 IDExecutionId不能同时为空。

  • 您可以设置NextToken查询凭证(Token),其取值是上一次调用DescribeImagePipelineExecutions返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数进行查询。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

Tag

array<object>

标签列表。

object

标签对象。

Key

string

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

TestKey

Value

string

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

TestValue

RegionId

string

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

cn-hangzhou

ImagePipelineId

string

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****

ExecutionId

string

镜像构建任务 ID。

exec-5fb8facb8ed7427c****

Status

string

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

  • PREPARING:准备中。创建临时中转实例等资源。

  • REPAIRING:修复中。修复源镜像。

  • BUILDING:构建中。执行用户自定义命令以及创建镜像。

  • TESTING:测试中。执行用户自定义测试命令。

  • DISTRIBUTING:分发中。执行镜像复制以及共享。

  • RELEASING:资源回收中。构建过程中生成的临时资源。

  • SUCCESS:成功。构建成功。

  • PARTITION_SUCCESS:部分成功。镜像已构建成功,但可能在分发或者资源清理等步骤出现了异常。

  • FAILED:失败。构建镜像失败。

  • TEST_FAILED:测试失败。镜像创建成功,但测试失败。

  • CANCELLING:取消中。正在取消构建流程。

  • CANCELLED:已取消。构建流程已取消。

说明

当参数值为空时,默认查询所有状态的镜像构建任务

BUILDING

NextToken

string

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

AAAAAdDWBF2****

MaxResults

integer

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

默认值:50。

50

返回参数

名称

类型

描述

示例值

object

NextToken

string

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

AAAAAdDWBF2****

RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

TotalCount

integer

返回的镜像组件数量。

1

MaxResults

integer

分页查询时每页行数。

50

ImagePipelineExecution

object

ImagePipelineExecutionSet

array<object>

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

array<object>

镜像构建任务的详细信息。

CreationTime

string

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

2020-11-24T06:00:00Z

ImagePipelineId

string

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****

Status

string

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

  • PREPARING:准备中。创建临时中转实例等资源。

  • REPAIRING:修复中。修复源镜像。

  • BUILDING:构建中。执行用户自定义命令以及创建镜像。

  • TESTING:测试中。执行用户自定义测试命令。

  • DISTRIBUTING:分发中。执行镜像复制以及共享。

  • RELEASING:资源回收中。构建过程中生成的临时资源。

  • SUCCESS:成功。构建成功。

  • PARTITION_SUCCESS:部分成功。镜像已构建成功,但可能在分发或者资源清理等步骤出现了异常。

  • FAILED:失败。构建镜像失败。

  • TEST_FAILED:测试失败。镜像创建成功,但测试失败。

  • CANCELLING:取消中。正在取消构建流程。

  • CANCELLED:已取消。构建流程已取消。

BUILDING

ModifiedTime

string

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

2020-11-25T06:00:00Z

ResourceGroupId

string

企业资源组 ID。

rg-bp67acfmxazb4p****

Message

string

执行结果信息。

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

ImageId

string

目标镜像 ID。

m-bp67acfmxazb4p****

ExecutionId

string

构建任务 ID。

exec-5fb8facb8ed7427c****

Tags

object

Tag

array<object>

标签列表。

object

标签对象。

TagValue

string

标签值。

TestKey

TagKey

string

标签键。

TestValue

ErrorCode

string

执行错误时的错误码。

NO_AVAILABLE_INSTANCE_TYPE

ErrorInfo

string

执行错误时的错误信息。

No available instance type to use.

示例

正常返回示例

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

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.Status %s
400 MissingParameter.ImagePipelineId The specified parameter ImagePipelineId should not be empty. 参数ImagePipelineId不为空。
400 InvalidExecutionId.SizeExceeded ExecutionId list exceeds maximum size of %s. Current size is %s. 您设置的ExecutionId列表大小超过了允许的最大值。
403 Invalid.NextToken The specified NextToken is not valid.
404 InvalidImagePipeline.NotFound %s

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

变更历史

更多信息,参考变更详情