ListImageVersions - ListImageVersions-DataWorks(DataWorks)-阿里云帮助中心

Retrieves version details for a specified image, including status, build configuration, and provider information.

Operation description

To use this API, you must purchase DataWorks Basic Edition or a later edition.
Ensure you create the service-linked role AliyunServiceRoleForDataWorks before you call this API.

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
Id	string	Yes	The image ID.	Custom_image_xxxx_xxxx
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The response structure.
Success	boolean	Whether the request was successful.	true
PagingInfo	object	The pagination information.
ImageVersions	array	The list of image version details.
	array	The details of the image version.
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, as a 64-bit timestamp.	1727055811000
LastModifiedTime	integer	The last modification time, as a 64-bit timestamp.	1727055811000
Official	boolean	Whether the image is an official image.	true
Accessibility	string	The accessibility of the image: Public: Visible to all users. 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: Publishing 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	Whether the image is the default image.	false
EnableSyncMaxCompute	boolean	Whether synchronization to 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 image 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 VPC URI of the image.	registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
AcrEndpoint	string	The ACR endpoint.	registry.cn-hangzhou.aliyuncs.com
AcrAssociatedVpcId	string	The ID of the VPC 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 contains package names, separate them with commas (,).	requests
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	10
RequestId	string	The request ID. Used to locate logs and troubleshoot issues.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Success": true,
  "PagingInfo": {
    "ImageVersions": [
      {
        "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.