文档

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

更新时间:

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

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeImagePipelineExecutionsRead
  • ImagePipeline
    acs:ecs:{#regionId}:{#accountId}:imagepipeline/*
  • ImagePipeline
    acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

请求参数

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

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

cn-hangzhou
Tagobject []
说明 该参数暂未开放使用。
Keystring
说明 该参数暂未开放使用。
null
Valuestring
说明 该参数暂未开放使用。
null
ImagePipelineIdstring

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****
ExecutionIdstring

镜像构建任务 ID。

exec-5fb8facb8ed7427c****
Statusstring

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

  • BUILDING:构建中。
  • DISTRIBUTING:分发中。
  • RELEASING:资源回收中。
  • SUCCESS:成功。
  • 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
ImagePipelineExecutionobject []

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

CreationTimestring

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

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

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****
Statusstring

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

  • BUILDING:构建中。
  • DISTRIBUTING:分发中。
  • RELEASING:资源回收中。
  • SUCCESS:成功。
  • 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****
Tagsobject []
说明 该参数暂未开放使用。
TagValuestring
说明 该参数暂未开放使用。
null
TagKeystring
说明 该参数暂未开放使用。
null

示例

正常返回示例

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": "null",
              "TagKey": "null"
            }
          ]
        }
      }
    ]
  }
}

错误码

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-

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

变更历史

变更时间变更内容概要操作
2023-04-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
  • 本页导读 (1)