調用ListImages API擷取鏡像列表-人工智慧平台 PAI-阿里雲

擷取鏡像列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

paiimage:ListImages

list

*全部資源

*

無

請求文法

GET /api/v1/images HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	鏡像名稱，支援模糊搜尋。	tensorflow_2.9
PageNumber	integer	否	鏡像列表的頁碼。起始值為 1，預設為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。預設為 20。	20
SortBy	string	否	分頁查詢時的排序欄位。目前 GmtCreateTime 欄位用於排序。	GmtCreateTime
Order	string	否	分頁查詢時，對指定的排序欄位進行升序或降序，與 SortBy 結合使用。預設 ASC。 ASC：升序。 DESC：降序。	DESC
Labels	string	否	標籤過濾條件，多個條件以半形逗號（,）分隔。單個條件過濾格式為`Key=Value`。 Key 支援如下值： system.chipType system.dsw.cudaVersion system.dsw.fromImageId system.dsw.fromInstanceId system.dsw.id system.dsw.os system.dsw.osVersion system.dsw.resourceType system.dsw.rootImageId system.dsw.stage system.dsw.tag system.dsw.type system.framework system.origin system.pythonVersion system.source system.supported.dlc system.supported.dsw	system.framework=XGBoost 1.6.0,system.official=true
Verbose	boolean	否	是否顯示非必要資訊，非必要資訊目前包含 Labels。取值如下： true：包含非必要資訊。 false：不包含非必要資訊。	true
WorkspaceId	string	否	工作空間 ID。如何擷取工作空間 ID，請參見 ListWorkspaces 。	20******55
Query	string	否	模糊搜尋鏡像名稱以及描述。	name
Accessibility	string	否	鏡像的可見度，目前只對自訂鏡像生效。 PUBLIC 表示公開。 PRIVATE 表示私人。	PUBLIC
ImageUri	string	否

返回參數

名稱	類型	描述	樣本值
	object	返回結構體。
RequestId	string	請求 ID。	5A14FA81-DD4E-******-6343FE44B941
TotalCount	integer	返回的鏡像總量。	2
Images	array<object>	鏡像列表。
	array<object>	鏡像詳情。
Name	string	鏡像名稱。	tensorflow_2.9
GmtCreateTime	string	建立 UTC 時間，日期格式為 ISO8601。	2021-01-21T17:12:35.232Z
Description	string	鏡像描述。	desc
ImageUri	string	鏡像地址，包含版本號碼。	registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0
Labels	array<object>	鏡像標籤列表。
	object	鏡像標籤。
Key	string	標籤的鍵。	system.chipType
Value	string	標籤的值。	GPU
ImageId	string	鏡像 ID。	image-tzi7f9******s45t
Accessibility	string	鏡像的可見度，可能值： PUBLIC：當前工作空間所有成員都可以操作。 PRIVATE：只有建立者可以操作。	PUBLIC
GmtModifiedTime	string	修改 UTC 時間，格式為 ISO8601。	2021-01-21T17:12:35.232Z
UserId	string	建立者的阿里雲帳號 UID。	155**********904
ParentUserId	string	建立者的阿里雲帳號 UID。	155**********904
WorkspaceId	string	工作空間 ID。	20******55
Size	integer	鏡像大小，單位為位元組。	2
SourceType	string	鏡像來源類型
SourceId	string	鏡像來源 ID

樣本

正常返回樣本

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "TotalCount": 2,
  "Images": [
    {
      "Name": "tensorflow_2.9",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Description": "desc",
      "ImageUri": "registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0",
      "Labels": [
        {
          "Key": "system.chipType",
          "Value": "GPU"
        }
      ],
      "ImageId": "image-tzi7f9******s45t",
      "Accessibility": "PUBLIC",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z\n",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "WorkspaceId": "20******55",
      "Size": 2,
      "SourceType": "",
      "SourceId": ""
    }
  ]
}

錯誤碼

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

變更歷史

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