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

Obtiene los detalles de una imagen especificada por ID de imagen.

Descripción de la operación

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

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:GetImage

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	string	Sí	El ID de la imagen.	Custom_image_xxxx_xxxx
ImageVersion	string	No	La versión de la imagen. Si no especifica este parámetro, se obtiene la versión más reciente.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
Success	boolean	Indica si la solicitud se realizó correctamente.	true
Image	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. El valor es una marca de tiempo de 64 bits.	1727055811000
LastModifiedTime	integer	La hora de la última modificación. El valor es una marca de tiempo de 64 bits.	1727055811000
Official	boolean	Indica si la imagen es una imagen oficial.	true
Accessibility	string	La visibilidad de la imagen. Valores válidos: Public: Visible para todos los usuarios. Private: 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: La imagen no está probada. Testing: La imagen se está probando. TestFailed: La prueba falló. Unpublished: La imagen no está publicada. Publishing: La imagen se está publicando. Published: La imagen está publicada. PublishFailed: La publicación falló. Building: La imagen se está compilando. BuildSuccess: La compilación se realizó correctamente. BuildFailed: La compilación falló. Accelerating: La imagen se está acelerando. AccelerateSuccess: La aceleración se realizó correctamente. AccelerateFailed: La aceleración falló.	Published
Supported	object	Los módulos y tipos de tarea admitidos.
Module	string	El módulo admitido. Valores válidos: Scheduler: Programación.	Scheduler
TaskTypes	array	La lista de tipos de tarea admitidos.
	string	Los tipos de tarea admitidos. 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	Endpoint de ACR.	registry.cn-hangzhou.aliyuncs.com
AcrAssociatedVpcId	string	El ID de la VPC asociada con 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 es una lista de nombres de paquetes de instalación, separe los nombres con comas (,).	requests
RequestId	string	El ID de la solicitud. Puede utilizar el ID para localizar registros y solucionar problemas.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "Image": {
    "Id": "Custom_image_xxxx_xxxx",
    "Name": "dataworks_image",
    "Version": "1",
    "Description": "Imagen de prueba creada por 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"
        }
      ]
    }
  },
  "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.