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

Cria uma imagem.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição mais avançada para usar este recurso.
Certifique-se de que a função vinculada ao serviço AliyunServiceRoleForDataWorks foi 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:CreateImage

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome da imagem. O nome pode conter letras minúsculas, dígitos e sublinhados (_) e ter até 128 caracteres de comprimento.	task_image_001
Description	string	Não	A descrição da imagem. A descrição pode ter até 128 caracteres de comprimento.	create by xxxx
Accessibility	string	Não	A visibilidade da imagem. Valores válidos: Public: A imagem é visível para todos os usuários. Private: A imagem é visível apenas para o criador. Valores válidos: Private : Private. Public : Public.	Public
ProviderType	string	Sim	O tipo de dados de referência da imagem. Valores válidos: ACR: Repositório de imagens do ACR. DataWorks: Imagem oficial do DataWorks. Valores válidos: ACR : Container Registry. DataWorks : DataWorks.	ACR
Namespace	string	Sim	O namespace da imagem. Se você referenciar uma imagem oficial do DataWorks, defina este parâmetro como DataWorks Default.	namespace_name
RepositoryName	string	Sim	O nome do repositório de imagens. Se você referenciar uma imagem oficial do DataWorks, defina este parâmetro como DataWorks Default.	repo_name
ProviderImageId	string	Não	O ID da imagem fornecida pelo provedor de imagens. Este parâmetro é obrigatório se você referenciar uma imagem oficial do DataWorks.	System_shell_20251201
AcrInstanceId	string	Não	O ID da instância ACR. Este parâmetro é obrigatório se você referenciar uma imagem do ACR.	acr_instance_id
ImageUri	string	Não	O URI da imagem. Este parâmetro é obrigatório se você referenciar uma imagem do ACR.	registry-vpc.cn-beijing.cr.aliyuncs.com/namespace/image:0.1.0
AcrAssociatedVpcId	string	Não	O ID da nuvem privada virtual (VPC) associada à instância ACR. Este parâmetro é obrigatório se você referenciar uma imagem do ACR.	vpc-xxx
EnableSyncMaxCompute	boolean	Não	Especifica se a imagem deve ser sincronizada com o MaxCompute. Especifique este parâmetro ao referenciar uma imagem do ACR. Valor padrão: false.	false
Supported	object	Sim	A subfinalidade da imagem.
Module	string	Não	O submódulo da imagem. Valores válidos: Scheduler: Data Studio. Valores válidos: Scheduler : Scheduler.	Scheduler
TaskTypes	array	Não	A lista de tipos de tarefa suportados pela imagem.
	string	Não	Os tipos de tarefa suportados. Valores válidos: Shell Python ServerIDE Notebook PyODPS 2 PyODPS 3 [_single.params.Supported.props.TaskTypes.items.enum.PyODPS 2]PyODPS 2 Valores válidos: PyODPS 2 : PyODPS 2 Shell : Shell. Notebook : Notebook [_single.params.Supported.props.TaskTypes.items.enum.PyODPS 3]PyODPS 3 PyODPS 3 : PyODPS 3 ServerIDE : ServerIDE. Python : Python.	Shell
BuildConfig	object	Não	A configuração de compilação da imagem.
BuildType	string	Não	O tipo de compilação. Valores válidos: PackageInstallation : Instalação de pacote.	PackageInstallation
PackageInstallationScripts	array<object>	Não	A lista de scripts de execução de pré-instalação.
	object	Não	O script de execução de pré-instalação.
Type	string	Não	O tipo do script. Valores válidos: Yum : YUM. Script : Script. Python2 : Python 2 Python3 : Python 3	Python3
Content	string	Não	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
ClientToken	string	Sim	O token do cliente usado para garantir a idempotência.	dasfsd-94fqwe-da8d

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ImageId	string	O ID da imagem criada.	Custom_image_xxxx_xxxx
RequestId	string	O ID da solicitação. Você pode usar o ID para consultar logs e solucionar problemas.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "ImageId": "Custom_image_xxxx_xxxx",
  "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.