ListImages - DataWorks

取得映像列表。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListImages

list

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	映像名稱，用於模糊查詢。	image
Statuses	array	否	查詢的映像狀態列表。
	string	否	映像狀態： Disabled：禁用； Expired：過期； Available：可用； ReadOnly：唯讀。枚舉值： ReadOnly : 只读 Available : 可用 Expired : 過期。 Disabled : 禁用	Enabled
Stages	array	否	查詢的映像發佈階段列表。
	string	否	發布狀態： Untest：未測試； Testing：測試中； TestFailed：測試失敗； Unpublished：未發布； Publishing：發布中； Published：已發布； PublishFailed：發布失敗； Building：建置中； BuildSuccess：建置成功。枚舉值： Building : 建置中。 TestFailed : 測試失敗。 Accelerating : 加速中 BuildSuccess : 建置成功。 BuildFailed : 建置失敗。 PublishFailed : 發布失敗。 AccelerateSuccess : 加速成功 Publishing : 發布中。 Unpublished : 待發布。 Published : 已發布。 AccelerateFailed : 加速失败 Untest : 未測試。 Testing : 測試中。	Published
Accessibility	string	否	可存取性： Public：全員可見； Private：僅建立者可見。	Public
ProjectIds	array	否	工作空間 ID 列表。
	integer	否	工作空間 ID。	10001
SupportedModules	array	否	支援的模組列表。
	string	否	支援的模組： Scheduler：排程。枚舉值： Scheduler : 排程。	Scheduler
SupportedTaskTypes	array	否	支援的任務類型列表。
	string	否	支援的任務類型： Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3。	Shell
ProviderTypes	array	否	映像引用類型列表。
	string	否	映像引用類型： ACR：ACR 映像儲存庫； DataWorks：DataWorks 官方映像。枚舉值： ACR : 容器映像服務 ACR。 MaxCompute : MaxCompute。 PAI : 人工智能平台 PAI 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"
}

錯誤碼

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

變更歷史

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