DocsICP FilingConsole
Documentation

UpdateImage

Updated at:
Copy as MD
Product
My Favorites

Updates an image.

Operation description

  1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.

  2. Before calling this operation, make sure that the service-linked role AliyunServiceRoleForDataWorks has been 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
Id

string

Yes

The image ID.

Custom_image_xxxx_xxxx
Name

string

No

The image name.

task_image_001
Description

string

No

The image description.

create by xxxx
Accessibility

string

No

The image visibility. Valid values:

  • Public: visible to all users.

  • Private: visible only to the creator.

Valid values:

  • Private :

    Private

  • Public :

    Public

Public
Supported

object

No

The image sub-purpose.

Module

string

No

The image sub-module. Valid values:

  • Scheduler: data development.

Valid values:

  • Scheduler :

    Scheduler

Scheduler
TaskTypes

array

No

The list of node types supported by the image.

string

No

The supported node type. Valid values:

  • Shell

  • Python

  • ServerIDE

  • Notebook

  • PyODPS 2

  • PyODPS 3

Valid values:

  • PyODPS 2 :

    PyODPS 2

  • Shell :

    Shell

  • Notebook :

    Notebook

  • PyODPS 3 :

    PyODPS 3

  • ServerIDE :

    ServerIDE

  • Python :

    Python

Shell
BuildConfig

object

No

The image build configuration.

BuildType

string

No

The build type.

PackageInstallation
PackageInstallationScripts

array<object>

No

The list of pre-installation scripts.

object

No

The pre-installation script.

Type

string

No

The script type.

Python3
Content

string

No

The script content. If the content consists of package names, separate them with commas (,).

requests
ProviderImageId

string

No

The provider image ID. This parameter is required when referencing a DataWorks official image.

System_shell_20251201
AcrInstanceId

string

No

The Container Registry (ACR) instance ID. This parameter is required when referencing an ACR image.

acr_instance_id
Namespace

string

No

The image namespace. Set this parameter to DataWorks Default when referencing a DataWorks official image.

namespace_name
RepositoryName

string

No

The image repository name. Set this parameter to DataWorks Default when referencing a DataWorks official image.

repo_name
ImageUri

string

No

The image URI. This parameter is required when referencing an ACR image.

registry-vpc.cn-beijing.cr.aliyuncs.com/namespace/image:0.1.0
AcrAssociatedVpcId

string

No

The VPC ID associated with the ACR instance. This parameter is required when referencing an ACR image.

vpc-xxx

Response elements

Element

Type

Description

Example

object

Schema of Response

Success

boolean

Indicates whether the request was successful.

true
Data

boolean

The result of the API request.

true
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,
  "Data": true,
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.