阿里云ECS云服务器DescribeImagePipelines-云淘科技

2023年12月9日下午5:06 • 阿里云服务器

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

接口说明

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

调试

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

请求参数


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

返回数据


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

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeImagePipelines
&RegionId=cn-hangzhou
&ImagePipelineId.1=ip-2ze5tsl5bp6nf2b3****
&

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml


    1
    AAAAAdDWBF2****
    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    50
    
        
            IMAGE
            This is description.
            rg-bp67acfmxazb4p****
            40
            ip-2ze5tsl5bp6nf2b3****
            vsw-bp67acfmxazb4p****
            testImagePipeline
            true
            testImageName
            0
            2020-11-24T06:00:00Z
            ecs.g6.large
            FROM IMAGE:m-bp67acfmxazb4p****
            m-bp67acfmxazb4p****
        
        
            
                
                    TestKey
                    TestValue
                
            
        
        
            
                ["1234567890"]
            
            
                ["cn-hangzhou"]

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码


HttpCode	错误码	错误信息	描述
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s	指定的ImagePipelineId.N数量超过上限，即N超过了上限。N的取值范围：1~20。

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

阿里云ECS云服务器DescribeImagePipelines-云淘科技

接口说明

调试

请求参数

返回数据

示例

错误码

联系我们

400-800-8888

阿里云ECS云服务器DescribeImagePipelines-云淘科技

接口说明

调试

请求参数

返回数据

示例

错误码

相关推荐

阿里云云原生大数据计算服务 MaxComputeSUBSTR-云淘科技

阿里云RDS数据库DescribeLocalAvailableRecoveryTime – 查询RDS实例备份可恢复的时间范围-云淘科技

阿里云RDS数据库DeleteDBInstanceEndpoint – 删除实例的Endpoint-云淘科技

阿里云RDS数据库ListClasses – 查询规格信息-云淘科技

阿里云人工智能平台PAIListGroups – 查看服务组列表-云淘科技

联系我们

400-800-8888