ListImageVersions-阿里云帮助中心

Gets the details of a specified image version.

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 schema.
Success	boolean	Indicates whether the request succeeded.	true
PagingInfo	object	The pagination details.
ImageVersions	array<object>	A list of image version details.
	array<object>	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 user who created the image.	123
Modifier	string	The ID of the user who last modified the image.	123
CreatedTime	integer	The time when the image was created, as a 64-bit timestamp.	1727055811000
LastModifiedTime	integer	The time when the image was last modified, as a 64-bit timestamp.	1727055811000
Official	boolean	Indicates whether the image is an official image.	true
Accessibility	string	The accessibility of the image. Valid values: `Public`: The image is visible to all users. `Private`: The image is visible only to the creator.	Public
Status	string	The status of the image. Valid values: `Disabled`: The image is disabled. `Expired`: The image is expired. `Available`: The image is available. `ReadOnly`: The image is read-only.	Available
PublishStage	string	The publishing stage of the image. Valid values: `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. Valid value: `Scheduler`: The scheduler module.	Scheduler
TaskTypes	array	The supported task types.
	string	The supported task type. Valid values: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
IsDefault	boolean	Indicates whether the image is the default image.	false
EnableSyncMaxCompute	boolean	Indicates whether MaxCompute synchronization is enabled.	false
ProviderType	string	The type of the image provider. Valid values: `ACR`: The image is from an ACR repository. `DataWorks`: The image is an official image provided by DataWorks.	ACR
ProviderImageId	string	The ID of the image from 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 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<object>	The pre-installation scripts.
	object	A pre-installation script.
Type	string	The script type.	Python3
Content	string	The script content. Separate multiple package names with a comma (,).	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.