GetImage - DataWorks: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma imagem especificada pelo ID da imagem.

Descrição da operação

É necessário o DataWorks Basic Edition ou superior.
Certifique-se de que a função vinculada ao serviço AliyunServiceRoleForDataWorks seja criada antes de chamar esta operação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:GetImage

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID da imagem.	Custom_image_xxxx_xxxx
ImageVersion	string	Não	A versão da imagem. Se você não especificar este parâmetro, a versão mais recente será obtida.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Image	object	Os detalhes da imagem.
Id	string	O ID da imagem.	Custom_image_xxxx_xxxx
Name	string	O nome da imagem.	dataworks_image
Version	string	A versão da imagem.	1
Description	string	A descrição da imagem.	Test image created by xxx
Creator	string	O ID do criador.	123
Modifier	string	O ID do modificador.	123
CreatedTime	integer	A hora de criação. O valor é um timestamp de 64 bits.	1727055811000
LastModifiedTime	integer	A hora da última modificação. O valor é um timestamp de 64 bits.	1727055811000
Official	boolean	Indica se a imagem é uma imagem oficial.	true
Accessibility	string	A visibilidade da imagem. Valores válidos: Public: Visível para todos os usuários. Private: Visível apenas para o criador.	Public
Status	string	O status da imagem. Valores válidos: Disabled: A imagem está desativada. Expired: A imagem expirou. Available: A imagem está disponível. ReadOnly: A imagem é somente leitura.	Available
PublishStage	string	O status de publicação. Valores válidos: Untest: A imagem não foi testada. Testing: A imagem está sendo testada. TestFailed: O teste falhou. Unpublished: A imagem não está publicada. Publishing: A imagem está sendo publicada. Published: A imagem está publicada. PublishFailed: A publicação falhou. Building: A imagem está sendo compilada. BuildSuccess: A compilação foi bem-sucedida. BuildFailed: A compilação falhou. Accelerating: A imagem está sendo acelerada. AccelerateSuccess: A aceleração foi bem-sucedida. AccelerateFailed: A aceleração falhou.	Published
Supported	object	Os módulos e tipos de tarefa suportados.
Module	string	O módulo suportado. Valores válidos: Scheduler: Agendamento.	Scheduler
TaskTypes	array	A lista de tipos de tarefa suportados.
	string	Os tipos de tarefa suportados. Valores válidos: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3	Shell
IsDefault	boolean	Indica se a imagem é a imagem padrão.	false
EnableSyncMaxCompute	boolean	Indica se a sincronização do MaxCompute está ativada.	false
ProviderType	string	O tipo de dados de referência da imagem. Valores válidos: ACR: Repositório de imagens do ACR. DataWorks: Imagem oficial do DataWorks.	ACR
ProviderImageId	string	O ID da imagem do provedor.	acr_image_id
ImageUri	string	O URI da imagem.	registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
Namespace	string	O namespace.	namespace
Size	string	O tamanho da imagem.	1GB
AcrInstanceId	string	O ID da instância ACR.	cri-xxx
ImageTag	string	A tag da imagem.	v1.0.0
RepositoryName	string	O nome do repositório.	repo_name
ImageVpcUri	string	O URI da VPC da imagem.	registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag
AcrEndpoint	string	Endpoint do ACR.	registry.cn-hangzhou.aliyuncs.com
AcrAssociatedVpcId	string	O ID da VPC associada à instância ACR.	vpc-xxx
BuildConfig	object	A configuração de compilação da imagem.
BuildType	string	O tipo de compilação.	PackageInstallation
PackageInstallationScripts	array<object>	A lista de scripts de execução de pré-instalação.
	object	O script de execução de pré-instalação.
Type	string	O tipo de script.	Python3
Content	string	O conteúdo do script. Se o conteúdo for uma lista de nomes de pacotes de instalação, separe os nomes com vírgulas (,).	requests
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "Image": {
    "Id": "Custom_image_xxxx_xxxx",
    "Name": "dataworks_image",
    "Version": "1",
    "Description": "Imagem de teste criada 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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.