ListImages - 擷取鏡像列表 - DataWorks

擷取鏡像列表。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
請確保在使用該介面前，已建立服務關聯角色 AliyunServiceRoleForDataWorks。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	鏡像名稱，用於模糊查詢	image
Statuses	array	否	查詢的鏡像狀態列表
	string	否	鏡像狀態： Disabled：禁用； Expired：到期； Available：可用； ReadOnly：唯讀。	Enabled
Stages	array	否	查詢的鏡像發布階段列表
	string	否	發布狀態： Untest：未測試； Testing：測試中； TestFailed：測試失敗； Unpublished：未發布； Publishing：發布中； Published：發行； PublishFailed：發布失敗； Building：構建中； BuildSuccess：構建成功；	Published
Accessibility	string	否	可訪問性： Public：全員可見； Private：僅建立者可見。	Public
ProjectIds	array	否	工作空間 ID 列表
	integer	否	工作空間 ID	10001
SupportedModules	array	否	支援的模組列表
	string	否	支援的模組： Scheduler：調度。	Scheduler
SupportedTaskTypes	array	否	支援的任務類型列表
	string	否	支援的任務類型： Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
ProviderTypes	array	否	鏡像參考型別列表
	string	否	鏡像參考型別： ACR：ACR 鏡像倉庫； DataWorks：DataWorks 官方鏡像。	ACR
PageSize	integer	否	分頁大小	10
PageNumber	integer	否	分頁頁碼	1
SortBy	string	否	排序欄位列表，支援定時時間、開始時間等欄位。格式為"排序欄位+排序方式(Desc/Asc)"（Asc 可以預設）。排序欄位的枚舉值如下： CreateTime (Desc/Asc)：建立時間； Name (Desc/Asc)：鏡像名稱。預設值為 CreateTime Asc	CreatedTime Desc
SearchAll	boolean	否	是否搜尋所有鏡像
Official	boolean	否	是否為官方鏡像

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Success	boolean	是否請求成功	true
PagingInfo	object	分頁列表
ImageList	array<object>	擷取到的鏡像詳情列表
	array<object>	鏡像詳細資料
Id	string	鏡像 ID	Custom_image_xxxx_xxxx
Name	string	鏡像名稱	dataworks_image
Version	string	鏡像版本	1
Description	string	鏡像描述	Test image created by xxx
Creator	string	建立人 ID	123
Modifier	string	修改人 ID	123
CreatedTime	integer	建立時間，為 64 位元時間戳記	1727055811000
LastModifiedTime	integer	最後修改時間，為 64 位元時間戳記	1727055811000
Official	boolean	是否為官方鏡像	true
Accessibility	string	可訪問性： Public：全員可見； Private：僅建立者可見。	Public
Status	string	鏡像狀態： Disabled：禁用； Expired：到期； Available：可用； ReadOnly：唯讀。	Available
PublishStage	string	發布狀態： Untest：未測試； Testing：測試中； TestFailed：測試失敗； Unpublished：未發布； Publishing：發布中； Published：發行； PublishFailed：發布失敗； Building：構建中； BuildSuccess：構建成功； BuildFailed：構建失敗； Accelerating：加速中； AccelerateSuccess：加速成功； AccelerateFailed：加速失敗。	Published
Supported	object	支援的模組和任務類型
Module	string	支援的模組： Scheduler：調度。	Scheduler
TaskTypes	array	支援的任務類型列表
	string	支援的任務類型： Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
IsDefault	boolean	是否為預設鏡像	false
EnableSyncMaxCompute	boolean	是否啟用同步 MaxCompute	false
ProviderType	string	鏡像參考型別： ACR：ACR 鏡像倉庫； DataWorks：DataWorks 官方鏡像。	ACR
ProviderImageId	string	鏡像提供方鏡像 ID	acr_image_id
ImageUri	string	鏡像 URI	registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
Namespace	string	命名空間	namespace
Size	string	鏡像大小	1GB
AcrInstanceId	string	ACR 執行個體 ID	cri-xxx
ImageTag	string	鏡像標籤	v1.0.0
RepositoryName	string	倉庫名稱	repo_name
ImageVpcUri	string	鏡像 VPC URI	registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
AcrEndpoint	string	ACR Endpoint	registry.cn-hangzhou.aliyuncs.com
AcrAssociatedVpcId	string	ACR 執行個體關聯專用網路 ID	vpc-xxx
BuildConfig	object	鏡像構建配置
BuildType	string	構建類型	PackageInstallation
PackageInstallationScripts	array<object>	預先安裝執行指令碼列表
	object	預先安裝執行指令碼
Type	string	指令碼類型	Python3
Content	string	指令碼內容，若為安裝包名稱則以英文逗號分隔	requests
PageNumber	integer	分頁頁碼	1
PageSize	integer	分頁大小	10
TotalCount	integer	全部資料條目	10
RequestId	string	請求的 ID，用於定位日誌，排查問題	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "PagingInfo": {
    "ImageList": [
      {
        "Id": "Custom_image_xxxx_xxxx",
        "Name": "dataworks_image",
        "Version": "1",
        "Description": "Test image created by xxx",
        "Creator": "123",
        "Modifier": "123",
        "CreatedTime": 1727055811000,
        "LastModifiedTime": 1727055811000,
        "Official": true,
        "Accessibility": "Public",
        "Status": "Available",
        "PublishStage": "Published",
        "Supported": {
          "Module": "Scheduler",
          "TaskTypes": [
            "Shell"
          ]
        },
        "IsDefault": false,
        "EnableSyncMaxCompute": false,
        "ProviderType": "ACR",
        "ProviderImageId": "acr_image_id",
        "ImageUri": "registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag",
        "Namespace": "namespace",
        "Size": "1GB",
        "AcrInstanceId": "cri-xxx",
        "ImageTag": "v1.0.0",
        "RepositoryName": "repo_name",
        "ImageVpcUri": "registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag",
        "AcrEndpoint": "registry.cn-hangzhou.aliyuncs.com",
        "AcrAssociatedVpcId": "vpc-xxx",
        "BuildConfig": {
          "BuildType": "PackageInstallation",
          "PackageInstallationScripts": [
            {
              "Type": "Python3",
              "Content": "requests"
            }
          ]
        }
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

錯誤碼

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

變更歷史

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