調用ListCustomImages介面擷取自訂鏡像列表-Simple Application Server-阿里雲 - Simple Application Server

查詢指定地區下一個或多個已建立的自訂映像資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:ListCustomImages

get

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/*

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	指定的輕量應用伺服器執行個體所屬的地區 ID。您可以呼叫 ListRegions 查看支援的阿里雲地區清單。	cn-hangzhou
ClientToken	string	否	保證請求冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參見如何保證冪等性。	123e4567-e89b-12d3-a456-426655440000
ImageIds	string	否	輕量應用伺服器的映像 ID。取值可以由多個執行個體 ID 組成一個 JSON 陣列，最多支援 100 個 ID，ID 之間用半形逗號（,）隔開。	["fe9c66133a9d4688872869726b52**", "794c230fd3e64ea19f83f4d7a0ad**"]
PageSize	integer	否	分頁查詢時設定的每頁列數。最大值：100。預設值：10。	10
PageNumber	integer	否	快照清單的頁碼。預設值：1。	1
ImageNames	string	否	輕量應用伺服器的映像名稱。取值可以由多個執行個體 ID 組成一個 JSON 陣列，最多支援 100 個 ID，ID 之間用半形逗號（,）隔開。	["test1**", "test2**"]
SystemSnapshotId	string	否	系統磁碟快照 ID。	s-bp14m09pq8***0g6
DataSnapshotId	string	否	資料磁碟快照 ID。	s-acscasca****
Tag	array<object>	否	自訂映像的標籤清單。
	object	否	標籤。
Key	string	否	自訂映像的標籤鍵。標籤鍵長度的取值範圍：1~64。N 的取值範圍：1~20。	TestKey
Value	string	否	自訂映像的標籤值。標籤值長度的取值範圍：1~64。N 的取值範圍：1~20。	TestValue
ResourceGroupId	string	否	資源群組 ID。	rg-aek2bti7cf7yj2i
Share	boolean	否	是否查詢共用映像。取值範圍： False：否。表示返回結果中不包括共用映像。 True：是。表示只返回共用映像。不填則預設返回所有映像。	False
InstanceId	string	否	映像來源的輕量應用伺服器執行個體 ID。	ace0706b2ac4454d984295a94213****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
CustomImages	array<object>	物件陣列。
	array<object>	物件。
CreationTime	string	快照建立時間。時間格式以 ISO8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2022-10-09T02:28:06Z
DataSnapshotName	string	資料磁碟快照名稱。	資料磁碟快照
SystemSnapshotId	string	系統磁碟快照 ID。	s-bp1h173hj21puxb***
InShare	boolean	自訂映像是否共用至 ECS。	false
InShareUser	boolean	自訂映像是否跨帳號共用。	False
InstanceId	string	映像來源的輕量應用伺服器執行個體 ID。	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	資料磁碟快照 ID。	s-bp19rn9u8eqzlfb***
RegionId	string	地區 ID。	cn-hangzhou
SystemSnapshotName	string	系統磁碟快照名稱。	系統磁碟快照
Description	string	描述資訊。	自訂映像-1
Name	string	自訂映像名稱。	test
ImageId	string	自訂映像 ID。	m-bp1e79zktg26n2b***
Status	string	自訂映像狀態。取值範圍： 0：複製中。 1：可用。 2：不可用。 3：建立失敗。 4：建立中。	1
Tags	array<object>	自訂映像的標籤清單。
	object	標籤。
Key	string	自訂映像的標籤鍵。	TestKey
Value	string	自訂映像的標籤值。	TestValue
InstanceName	string	輕量應用伺服器執行個體名稱。	swas-asdf23***
ResourceGroupId	string	資源群組 ID。	rg-acfm2h2lvp3ublq
CreateInstances	array	使用映像建立的執行個體資訊。
	string	使用映像建立的執行個體 ID。	9ffb716db6ae406ca78a476c0c81****
UserId	integer	映像擁有者的阿里雲主帳號 ID。	180185828710****
OsType	string	映像的作業系統類型。	Linux
RequiredSystemDiskSize	integer	映像的系統磁碟大小，單位為 GiB。	20
RequiredDataDiskSize	integer	映像的資料磁碟大小，單位為 GiB。	20
SourceImageName	string	來源映像名稱。	CentOS
SourceImageVersion	string	來源映像版本。	8.0
TotalCount	string	總筆數。	4
PageSize	string	分頁查詢時設定的每頁列數。	10
PageNumber	string	頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "Data disk snapshot",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "System disk snapshot",
      "Description": "Custom image-1",
      "Name": "test",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "swas-asdf23***",
      "ResourceGroupId": "rg-acfm2h2lvp3ublq",
      "CreateInstances": [
        "9ffb716db6ae406ca78a476c0c81****"
      ],
      "UserId": 0,
      "OsType": "Linux",
      "RequiredSystemDiskSize": 20,
      "RequiredDataDiskSize": 20,
      "SourceImageName": "CentOS",
      "SourceImageVersion": "8.0"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request.

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

變更歷史

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