ListImages - DataWorks - Centro de documentación de Alibaba Cloud

Obtiene una lista de imágenes.

Descripción de la operación

Se requiere DataWorks Basic Edition o una versión posterior.
Antes de llamar a esta operación, asegúrese de que se haya creado el rol vinculado al servicio AliyunServiceRoleForDataWorks.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:ListImages

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	No	El nombre de la imagen utilizado para la coincidencia aproximada.	image
Statuses	array	No	La lista de estados de imagen a consultar.
	string	No	El estado de la imagen. Valores válidos: Disabled: La imagen está deshabilitada. Expired: La imagen ha caducado. Available: La imagen está disponible. ReadOnly: La imagen es de solo lectura. Valores válidos: ReadOnly : Read-only. Available : Available. Expired : Expired. Disabled : Disabled.	Enabled
Stages	array	No	La lista de etapas de publicación de imagen a consultar.
	string	No	El estado de publicación. Valores válidos: Untest: La imagen no está probada. Testing: La imagen se está probando. TestFailed: La prueba de la imagen falló. Unpublished: La imagen no está publicada. Publishing: La imagen se está publicando. Published: La imagen está publicada. PublishFailed: La publicación de la imagen falló. Building: La imagen se está compilando. BuildSuccess: La compilación de la imagen se completó correctamente. Valores válidos: Building : Building. TestFailed : Test failed. Accelerating : Accelerating. BuildSuccess : Build succeeded. BuildFailed : Build failed. PublishFailed : Publish failed. AccelerateSuccess : Acceleration succeeded. Publishing : Publishing. Unpublished : Unpublished. Published : Published. AccelerateFailed : Acceleration failed. Untest : Untested. Testing : Testing.	Published
Accessibility	string	No	La accesibilidad de la imagen. Valores válidos: Public: La imagen es visible para todos los usuarios. Private: La imagen es visible solo para el creador.	Public
ProjectIds	array	No	La lista de ID de espacios de trabajo.
	integer	No	El ID del espacio de trabajo.	10001
SupportedModules	array	No	La lista de módulos compatibles.
	string	No	El módulo compatible. Valores válidos: Scheduler: el módulo de programación. Valores válidos: Scheduler : Scheduling.	Scheduler
SupportedTaskTypes	array	No	La lista de tipos de tarea compatibles.
	string	No	El tipo de tarea compatible. Valores válidos: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
ProviderTypes	array	No	La lista de tipos de datos de referencia de imagen.
	string	No	El tipo de datos de referencia de la imagen. Valores válidos: ACR: Repositorio de imágenes de ACR. DataWorks: Imagen oficial de DataWorks. Valores válidos: ACR : Container Registry. MaxCompute : MaxCompute PAI : Platform for AI. DataWorks : DataWorks	ACR
PageSize	integer	No	El número de entradas por página.	10
PageNumber	integer	No	El número de página.	1
SortBy	string	No	La lista de campos de ordenación. Se admiten campos como la hora programada y la hora de inicio. El formato es "campo de ordenación + orden de clasificación (Desc/Asc)". Se puede omitir Asc. Valores válidos para los campos de ordenación: CreateTime (Desc/Asc): hora de creación. Name (Desc/Asc): nombre de la imagen. Valor predeterminado: CreateTime Asc.	CreatedTime Desc
SearchAll	boolean	No	Especifica si se deben buscar todas las imágenes.
Official	boolean	No	Especifica si la imagen es una imagen oficial.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
Success	boolean	Indica si la solicitud se realizó correctamente.	true
PagingInfo	object	La lista paginada.
ImageList	array<object>	La lista de detalles de las imágenes obtenidas.
	array<object>	Los detalles de la imagen.
Id	string	El ID de la imagen.	Custom_image_xxxx_xxxx
Name	string	El nombre de la imagen.	dataworks_image
Version	string	La versión de la imagen.	1
Description	string	La descripción de la imagen.	Test image created by xxx
Creator	string	El ID del creador.	123
Modifier	string	El ID del modificador.	123
CreatedTime	integer	La hora de creación. Este valor es una marca de tiempo de 64 bits.	1727055811000
LastModifiedTime	integer	La hora de la última modificación. Este valor es una marca de tiempo de 64 bits.	1727055811000
Official	boolean	Especifica si la imagen es una imagen oficial.	true
Accessibility	string	La accesibilidad de la imagen. Valores válidos: Public: La imagen es visible para todos los usuarios. Private: La imagen es visible solo para el creador.	Public
Status	string	El estado de la imagen. Valores válidos: Disabled: La imagen está deshabilitada. Expired: La imagen ha caducado. Available: La imagen está disponible. ReadOnly: La imagen es de solo lectura.	Available
PublishStage	string	El estado de publicación. Valores válidos: Untest: No probado. Testing: En pruebas. TestFailed: Prueba fallida. Unpublished: No publicado. Publishing: En publicación. Published: Publicado. PublishFailed: Publicación fallida. Building: En compilación. BuildSuccess: Compilación exitosa. BuildFailed: Compilación fallida. Accelerating: En aceleración. AccelerateSuccess: Aceleración exitosa. AccelerateFailed: Aceleración fallida.	Published
Supported	object	Los módulos y tipos de tareas admitidos.
Module	string	El módulo compatible. Valores válidos: Scheduler: el módulo de programación.	Scheduler
TaskTypes	array	La lista de tipos de tarea compatibles.
	string	El tipo de tarea compatible. Valores válidos: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
IsDefault	boolean	Indica si la imagen es la imagen predeterminada.	false
EnableSyncMaxCompute	boolean	Indica si la sincronización de MaxCompute está habilitada.	false
ProviderType	string	El tipo de datos de referencia de la imagen. Valores válidos: ACR: Repositorio de imágenes de ACR. DataWorks: Imagen oficial de DataWorks.	ACR
ProviderImageId	string	El ID de la imagen del proveedor.	acr_image_id
ImageUri	string	El URI de la imagen.	registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
Namespace	string	El espacio de nombres.	namespace
Size	string	El tamaño de la imagen.	1GB
AcrInstanceId	string	El ID de la instancia de ACR.	cri-xxx
ImageTag	string	La etiqueta de la imagen.	v1.0.0
RepositoryName	string	El nombre del repositorio.	repo_name
ImageVpcUri	string	El URI de VPC de la imagen.	registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
AcrEndpoint	string	El endpoint de ACR.	registry.cn-hangzhou.aliyuncs.com
AcrAssociatedVpcId	string	El ID de la VPC asociada a la instancia de ACR.	vpc-xxx
BuildConfig	object	La configuración de compilación de la imagen.
BuildType	string	El tipo de compilación.	PackageInstallation
PackageInstallationScripts	array<object>	La lista de scripts de ejecución de preinstalación.
	object	El script de ejecución de preinstalación.
Type	string	El tipo de script.	Python3
Content	string	El contenido del script. Si el contenido consiste en nombres de paquetes de instalación, separe los nombres con comas (,).	requests
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página.	10
TotalCount	integer	El número total de entradas de datos.	10
RequestId	string	El ID de la solicitud, que se utiliza para localizar registros y solucionar problemas.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.