ListImages - ListImages-阿里云帮助中心

Operation description

You must have DataWorks Basic Edition or a later version to use this API.
Before you use this API, make sure that the service-linked role AliyunServiceRoleForDataWorks is created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The image name, used for fuzzy search.	image
Statuses	array	No	The list of image statuses to query.
	string	No	The image status: Disabled: The image is disabled. Expired: The image has expired. Available: The image is available. ReadOnly: The image is read-only.	Enabled
Stages	array	No	The list of image publish stages to query.
	string	No	The publish stage: Untest: Not tested. Testing: Being tested. TestFailed: Test failed. Unpublished: Not published. Publishing: Being published. Published: Published. PublishFailed: Publish failed. Building: Being built. BuildSuccess: Build succeeded.	Published
Accessibility	string	No	The accessibility: Public: Visible to all members. Private: Visible only to the creator.	Public
ProjectIds	array	No	The list of workspace IDs.
	integer	No	The workspace ID.	10001
SupportedModules	array	No	The list of supported modules.
	string	No	The supported module: Scheduler: Scheduling.	Scheduler
SupportedTaskTypes	array	No	The list of supported task types.
	string	No	The supported task type: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
ProviderTypes	array	No	The list of image provider types.
	string	No	The image provider type: ACR: ACR image repository. DataWorks: DataWorks official image.	ACR
PageSize	integer	No	The page size.	10
PageNumber	integer	No	The page number.	1
SortBy	string	No	The list of sort fields. You can sort by scheduled time, start time, and other fields. The format is "SortField+SortOrder(Desc/Asc)", where Asc is the default and can be omitted. Valid values of sort fields: CreateTime (Desc/Asc): The creation time. Name (Desc/Asc): The image name. Default value: CreateTime Asc.	CreatedTime Desc
SearchAll	boolean	No	Specifies whether to search all images.
Official	boolean	No	Specifies whether the image is an official image.

Response elements

Element	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
ImageList	array	The list of image details.
	array	The image details.
Id	string	The image ID.	Custom_image_xxxx_xxxx
Name	string	The image name.	dataworks_image
Version	string	The image version.	1
Description	string	The image description.	Test image created by xxx
Creator	string	The ID of the creator.	123
Modifier	string	The ID of the modifier.	123
CreatedTime	integer	The creation time, represented as a 64-bit timestamp.	1727055811000
LastModifiedTime	integer	The last modification time, represented as a 64-bit timestamp.	1727055811000
Official	boolean	Indicates whether the image is an official image.	true
Accessibility	string	The accessibility: Public: Visible to all members. Private: Visible only to the creator.	Public
Status	string	The image status: Disabled: The image is disabled. Expired: The image has expired. Available: The image is available. ReadOnly: The image is read-only.	Available
PublishStage	string	The publish stage: Untest: Not tested. Testing: Being tested. TestFailed: Test failed. Unpublished: Not published. Publishing: Being published. Published: Published. PublishFailed: Publish failed. Building: Being built. BuildSuccess: Build succeeded. BuildFailed: Build failed. Accelerating: Being accelerated. AccelerateSuccess: Acceleration succeeded. AccelerateFailed: Acceleration failed.	Published
Supported	object	The supported modules and task types.
Module	string	The supported module: Scheduler: Scheduling.	Scheduler
TaskTypes	array	The list of supported task types.
	string	The supported task type: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
IsDefault	boolean	Indicates whether the image is the default image.	false
EnableSyncMaxCompute	boolean	Indicates whether synchronization with MaxCompute is enabled.	false
ProviderType	string	The image provider type: ACR: ACR image repository. DataWorks: DataWorks official image.	ACR
ProviderImageId	string	The image ID assigned by the provider.	acr_image_id
ImageUri	string	The image URI.	registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
Namespace	string	The namespace.	namespace
Size	string	The image size.	1GB
AcrInstanceId	string	The ACR instance ID.	cri-xxx
ImageTag	string	The image tag.	v1.0.0
RepositoryName	string	The repository name.	repo_name
ImageVpcUri	string	The image VPC URI.	registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
AcrEndpoint	string	ACR Endpoint	registry.cn-hangzhou.aliyuncs.com
AcrAssociatedVpcId	string	The VPC ID associated with the ACR instance.	vpc-xxx
BuildConfig	object	The image build configuration.
BuildType	string	The build type.	PackageInstallation
PackageInstallationScripts	array	The list of pre-installation scripts.
	object	The pre-installation script.
Type	string	The script type.	Python3
Content	string	The script content. If the content specifies package names, separate them with commas (,).	requests
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
TotalCount	integer	The total number of entries.	10
RequestId	string	The request ID, which is used to locate logs and troubleshoot issues.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.