查詢指定地域下一個或多個已創建的自定義鏡像信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| swas-open:ListCustomImages | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | 否 | 分頁查詢時設置的每頁行數。
| 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 |
| InstanceId | string | 否 | 鏡像的來源輕量應用服務器實例 ID。 | ace0706b2ac4454d984295a94213**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"CustomImages": [
{
"CreationTime": "2022-10-09T02:28:06Z",
"DataSnapshotName": "數據盤快照",
"SystemSnapshotId": "s-bp1h173hj21puxb***",
"InShare": false,
"InShareUser": true,
"InstanceId": "2d06ee0520b44de1ae88d4be****",
"DataSnapshotId": "s-bp19rn9u8eqzlfb***",
"RegionId": "cn-hangzhou",
"SystemSnapshotName": "系統盤快照",
"Description": "自定義鏡像-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. | 內部錯誤，請重試。如果多次嘗試失敗，請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-10-09 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-07-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-02-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |