DescribeImagePipelines - 查询一个或多个镜像模板的详细信息 - 云服务器 ECS

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeImagePipelines	get	ImagePipeline `acs:ecs:{#regionId}:{#accountId}:imagepipeline/` *ImagePipeline `acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
ResourceGroupId	string	否	企业资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	标签键。N 的取值范围：1~20。	TestKey
Value	string	否	标签值。N 的取值范围：1~20。	TestValue
Name	string	否	模板名称。	testImagePipeline
NextToken	string	否	查询凭证（Token）。取值为上一次调用该接口返回的`NextToken`参数值，初次调用接口时无需设置该参数。	AAAAAdDWBF2****
MaxResults	integer	否	分页查询时每页行数。取值范围：1~500。默认值：50。	50
ImagePipelineId	array	否	镜像模板 ID。N 取值范围：1~20。
	string	否	镜像模板 ID。N 取值范围：1~20。	ip-2ze5tsl5bp6nf2b3****

返回参数

名称	类型	描述	示例值
	object
NextToken	string	本次调用返回的查询凭证（Token）。具体使用方式请参见接口说明。	AAAAAdDWBF2****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返回的镜像模板数量。	1
MaxResults	integer	分页查询时每页行数。	50
ImagePipeline	array<object>	镜像模板的详细信息组成的列表。
ImagePipelineSet	object
CreationTime	string	模板创建时间。	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	镜像构建失败后是否释放中转实例。	true
InstanceType	string	实例规格。	ecs.g6.large
InternetMaxBandwidthOut	integer	中转实例的公网出带宽大小。单位：Mbit/s	0
ImagePipelineId	string	镜像模板 ID。	ip-2ze5tsl5bp6nf2b3****
VSwitchId	string	VPC 的交换机 ID。	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	中转实例的系统盘大小。单位：GiB	40
Description	string	描述信息。	This is description.
BaseImage	string	源镜像。当`BaseImageType=IMAGE`时，该参数值为自定义镜像 ID。当`BaseImageType=IMAGE_FAMILY`时，该参数值为镜像族系名称。	m-bp67acfmxazb4p****
ResourceGroupId	string	企业资源组 ID。	rg-bp67acfmxazb4p****
ImageName	string	目标镜像名称前缀。	testImageName
BaseImageType	string	源镜像类型。可能值： IMAGE：自定义镜像。 IMAGE_FAMILY：镜像族系。	IMAGE
Name	string	模板名称。	testImagePipeline
BuildContent	string	镜像模板内容。	RUN echo hello world
Tags	array<object>	标签键值对列表。
Tag	object
TagValue	string	标签值。	TestValue
TagKey	string	标签键。	TestKey
ToRegionIds	array	目标镜像待分发的地域列表。
ToRegionId	string	目标镜像待分发的地域列表。	["cn-hangzhou"]
AddAccounts	array	目标镜像共享的阿里云账号 ID。
AddAccount	string	目标镜像共享的阿里云账号 ID。	["1234567890"]
RepairMode	string	镜像模版中的修复选项。取值范围： Standard：标准模式。	Standard
TestContent	string	镜像测试模板内容。	RUN echo hello world
ImageFamily	string	目标镜像族系。	family

示例

正常返回示例

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": "RUN echo hello world",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "TestContent": "RUN echo hello world",
        "ImageFamily": "family"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-10-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情