文档

DescribeImagePipelines - 查询一个或多个镜像模板的详细信息

更新时间:

调用DescribeImagePipelines查询一个或多个镜像模板的详细信息。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
ResourceGroupIdstring

企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-bp67acfmxazb4p****
Tagobject []

标签列表。

Keystring

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

TestKey
Valuestring

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

TestValue
Namestring

模板名称。

testImagePipeline
NextTokenstring

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

AAAAAdDWBF2****
MaxResultsinteger

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

默认值:50。

50
ImagePipelineIdarray

镜像模板 ID。N 取值范围:1~20。

string

镜像模板 ID。N 取值范围:1~20。

ip-2ze5tsl5bp6nf2b3****

返回参数

名称类型描述示例值
object
NextTokenstring

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

AAAAAdDWBF2****
RequestIdstring

请求 ID。

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

返回的镜像模板数量。

1
MaxResultsinteger

分页查询时每页行数。

50
ImagePipelineobject []

镜像模板的详细信息组成的列表。

CreationTimestring

模板创建时间。

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

镜像构建失败后是否释放中转实例。

true
InstanceTypestring

实例规格。

ecs.g6.large
InternetMaxBandwidthOutinteger

中转实例的公网出带宽大小。单位:Mbit/s

0
ImagePipelineIdstring

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****
VSwitchIdstring

VPC 的交换机 ID。

vsw-bp67acfmxazb4p****
SystemDiskSizeinteger

中转实例的系统盘大小。单位:GiB

40
Descriptionstring

描述信息。

This is description.
BaseImagestring

源镜像。

  • BaseImageType=IMAGE时,该参数值为自定义镜像 ID。
  • BaseImageType=IMAGE_FAMILY时,该参数值为镜像族系名称。
m-bp67acfmxazb4p****
ResourceGroupIdstring

企业资源组 ID。

rg-bp67acfmxazb4p****
ImageNamestring

目标镜像名称前缀。

testImageName
BaseImageTypestring

源镜像类型。可能值:

  • IMAGE:自定义镜像。
  • IMAGE_FAMILY:镜像族系。
IMAGE
Namestring

模板名称。

testImagePipeline
BuildContentstring

镜像模板内容。

FROM IMAGE:m-bp67acfmxazb4p****
Tagsobject []

标签键值对列表。

TagValuestring

标签值。

TestValue
TagKeystring

标签键。

TestKey
ToRegionIdsarray

目标镜像待分发的地域列表。

string

目标镜像待分发的地域列表。

["cn-hangzhou"]
AddAccountsarray

目标镜像共享的阿里云账号 ID。

string

目标镜像共享的阿里云账号 ID。

["1234567890"]

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "VSwitchId": "vsw-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Description": "This is description.",
        "BaseImage": "m-bp67acfmxazb4p****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ImageName": "testImageName",
        "BaseImageType": "IMAGE",
        "Name": "testImagePipeline",
        "BuildContent": "FROM IMAGE:m-bp67acfmxazb4p****",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidImagePipelineIdSize.ExceededMaxNumber%s指定的ImagePipelineId.N数量超过上限,即N超过了上限。N的取值范围:1~20。
400InvalidName.Malformed%s-
403Invalid.NextTokenThe specified NextToken is not valid.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)