ListImageVersions - 获取指定镜像版本详情

更新时间:
复制为 MD 格式

获取指定镜像版本详情。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

  2. 请确保在使用该接口前,已创建服务关联角色 AliyunServiceRoleForDataWorks。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Id

string

镜像 ID

Custom_image_xxxx_xxxx

PageNumber

integer

分页页码

1

PageSize

integer

分页大小

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

Success

boolean

是否请求成功

true

PagingInfo

object

分页列表

ImageVersions

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情