DescribeImagePipelines - 查詢鏡像模板的詳細資料 - Elastic Compute Service

查詢一個或多個鏡像模板的詳細資料。

介面說明

您可以設定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
RegionId	string	是	所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
ResourceGroupId	string	否	企業資源組 ID。使用該參數過濾資源時，資源數量不能超過 1000 個。說明不支援預設資源群組過濾。	rg-bp67acfmxazb4p****
Name	string	否	模板名稱。	testImagePipeline
NextToken	string	否	查詢憑證（Token）。取值為上一次調用該介面返回的`NextToken`參數值，初次調用介面時無需設定該參數。	AAAAAdDWBF2****
MaxResults	integer	否	分頁查詢時每頁行數。取值範圍：1~500。預設值：50。	50
ImagePipelineId	array	否	鏡像模板 ID。N 取值範圍：1~20。	ip-2ze5tsl5bp6nf2b3****
	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	object
ImagePipelineSet	array<object>	鏡像模板的詳細資料組成的列表。
	array<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 `deprecated`	string	目標鏡像名稱首碼。重要該參數已棄用。請使用 ImageOptions.ImageName。	testImageName
BaseImageType	string	源鏡像類型。可能值： IMAGE：自訂鏡像。 IMAGE_FAMILY：鏡像族系。	IMAGE
Name	string	模板名稱。	testImagePipeline
BuildContent	string	鏡像模板內容。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
Tags	object
Tag	array<object>	標籤索引值對列表。
	object
TagValue	string	標籤值。	TestValue
TagKey	string	標籤鍵。	TestKey
ToRegionIds	object
ToRegionId	array	目標鏡像待分發的地區列表。
	string	目標鏡像待分發的地區列表。	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	目標鏡像共用的阿里雲帳號 ID。
	string	目標鏡像共用的阿里雲帳號 ID。	["1234567890"]
RepairMode	string	鏡像模版中的修複選項。取值範圍： Standard：標準模式。	Standard
TestContent	string	鏡像測試模板內容。	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily `deprecated`	string	目標鏡像族系。重要該參數已棄用。請使用 ImageOptions.ImageFamily。	family
NvmeSupport `deprecated`	string	構建的目標鏡像是否支援 NVMe。重要該參數已棄用。請使用 ImageOptions. ImageFeatures.NvmeSupport。	auto
ImportImageOptions	object	匯入鏡像的屬性和設定。
Architecture	string	系統架構。取值範圍： x86_64。 arm64。	x86_64
OSType	string	作業系統類型。可能值： windows。 linux。	linux
Platform	string	作業系統版本。取值範圍： Aliyun Anolis CentOS Ubuntu CoreOS SUSE Debian OpenSUSE FreeBSD RedHat Kylin UOS Fedora Fedora CoreOS CentOS Stream AlmaLinux Rocky Linux Gentoo Customized Linux Others Linux Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows Server 2012 Windows Server 2008 Windows Server 2003 Other Windows	Aliyun
BootMode	string	匯入鏡像的啟動模式。取值範圍： BIOS：BIOS 啟動模式。 UEFI：UEFI 啟動模式。	BIOS
LicenseType	string	匯入鏡像後，啟用作業系統採用的許可證類型。取值範圍： Auto：由阿里雲檢測源作業系統並分配許可證。自動模式下，系統優先搜尋您設定的`Platform`是否有阿里雲官方渠道的許可證並分配給匯入的鏡像，如果缺乏該類許可，會切換成 BYOL（Bring Your Own License）方式。 Aliyun：根據您設定的`Platform`採用阿里雲官方渠道的許可證。 BYOL：源作業系統內建的許可證。採用 BYOL 時，您必須確保您的許可證密鑰支援在阿里雲使用。	Auto
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	建立的自訂鏡像資訊列表。 N=1 時，表示系統硬碟. N=2~17 時，表示資料盤。
	object
OSSBucket	string	鏡像檔案所在的 OSS Bucket。	ecsimageos
OSSObject	string	鏡像上傳至 OSS Bucket 後，儲存在 Bucket 中的鏡像檔案的檔案名稱（key）。	CentOS_5.4_32.raw
Format	string	鏡像格式。取值範圍： RAW。 VHD。 QCOW2。	RAW
DiskImageSize	integer	匯入鏡像後，自訂鏡像的空間大小。該空間由系統硬碟和資料盤組成，您必須保證系統硬碟的空間大小大於等於匯入的鏡像檔案大小。取值範圍： N=1 時，表示系統硬碟，取值範圍：1 GiB~2048 GiB。 N=2~17 時，表示資料盤。取值範圍：1 GiB~2048 GiB。當您將源鏡像檔案上傳至 OSS 後，可以在 OSS Bucket 中查看鏡像檔案的大小。	40
Features	object	鏡像特性相關屬性。
NvmeSupport	string	匯入的鏡像是否支援 NVMe。可能值： supported：支援。表示以該鏡像建立的執行個體支援 NVMe 協議。 unsupported：不支援。表示以該鏡像建立的執行個體不支援 NVMe 協議。	supported
ImdsSupport	string
RetainImportedImage	boolean	說明該參數正在邀測中。	false
RetentionStrategy	string
ImageName	string
Description	string
RoleName	string
ImportImageTags	object
ImportImageTag	array<object>
	object
Key	string
Value	string
AdvancedOptions	object	進階設定。
RetainCloudAssistant	boolean	是否保留雲助手。構建過程中，系統會自動在中轉執行個體中安裝雲助手以執行命令，您可以選擇是否在構建的目標鏡像中保留。可能值： true：保留。 false：不保留。說明該設定不會對您鏡像中內建的雲助手產生任何影響。	true
ImageNameSuffix	string	是否禁用目標鏡像名稱自動增加尾碼。可能值： disable：禁用。	disable
ImageOptions	object	目標鏡像屬性。
ImageName	string	目標鏡像名稱首碼。	imageName
ImageFamily	string	目標鏡像族系。	family
Description	string	目標鏡像的描述資訊。	description.
ImageFeatures	object	目標鏡像特性相關屬性。
NvmeSupport	string	構建的目標鏡像是否支援 NVMe。可能值： supported：支援。表示以該鏡像建立的執行個體支援 NVMe 協議。 unsupported：不支援。表示以該鏡像建立的執行個體不支援 NVMe 協議。 auto：自動檢測。由系統自動檢測您的鏡像是否安裝 NVMe 驅動，該行為發生在構建階段前，若您在構建時安裝或者卸載了 NVMe 驅動，可能會出現結果偏差，建議您根據構建內容設定為 supported 或 unsupported。	auto
ImageTags	object
ImageTag	array<object>	目標鏡像標籤。
	object
TagKey	string	標籤鍵。	testKey
TagValue	string	標籤值。	testValue

樣本

正常返回樣本

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": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ImageFamily": "family",
        "NvmeSupport": "auto",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux",
          "Platform": "Aliyun",
          "BootMode": "BIOS",
          "LicenseType": "Auto",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw",
                "Format": "RAW",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported",
            "ImdsSupport": ""
          },
          "RetainImportedImage": false,
          "RetentionStrategy": "",
          "ImageName": "",
          "Description": "",
          "RoleName": "",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "",
                "Value": ""
              }
            ]
          }
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true,
          "ImageNameSuffix": "disable"
        },
        "ImageOptions": {
          "ImageName": "imageName",
          "ImageFamily": "family",
          "Description": "description.",
          "ImageFeatures": {
            "NvmeSupport": "auto"
          },
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey",
                "TagValue": "testValue"
              }
            ]
          }
        }
      }
    ]
  }
}

錯誤碼

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。