ModifyImageAttribute - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Chama a API ModifyImageAttribute para modificar os atributos de uma imagem personalizada, como a família de imagens, nome, modo de inicialização, status ou suporte a NVMe.

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

ecs:ModifyImageAttribute

update

*Image

acs:ecs:{#regionId}:{#accountId}:image/{#imageId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região onde a imagem personalizada está localizada. Você pode chamar a operação DescribeRegions para visualizar a lista mais recente de regiões da Alibaba Cloud.	cn-hangzhou
ImageId	string	Sim	O ID da imagem personalizada.	m-bp18ygjuqnwhechc****
ImageName	string	Não	O nome da imagem personalizada. O nome deve ter de 2 a 128 caracteres. Deve começar com uma letra ou um caractere chinês. O nome não pode começar com aliyun ou acs: e não pode conter http:// ou https://. Pode conter dígitos, pontos (.), dois-pontos (:), sublinhados (_) e hifens (-). Se você não especificar este parâmetro, o nome original será mantido.	testImageName
Status	string	Não	O status da imagem. Valores válidos: Deprecated: Descontinua a imagem. Se uma imagem personalizada que você deseja descontinuar estiver compartilhada, você deve cancelar o compartilhamento primeiro. Você não pode compartilhar ou copiar uma imagem descontinuada. No entanto, você pode usar a imagem para criar uma instância ou substituir um disco do sistema. Available: Torna a imagem disponível. Você pode alterar o status de uma imagem descontinuada para Available. Nota No entanto, se esta for a única imagem personalizada disponível na família de imagens, descontinuá-la impede a criação de instâncias a partir de qualquer imagem dessa família. Use esta opção com cautela.	Deprecated
ImageFamily	string	Não	O nome da família de imagens. O nome deve ter de 2 a 128 caracteres. Deve começar com uma letra ou um caractere chinês. O nome não pode começar com aliyun ou acs: e não pode conter http:// ou https://. Pode conter dígitos, pontos (.), dois-pontos (:), sublinhados (_) e hifens (-). Por padrão, este parâmetro está vazio.	hangzhou-daily-update
BootMode	string	Não	O modo de inicialização da imagem. Valores válidos: BIOS: Modo de inicialização BIOS. UEFI: Modo de inicialização UEFI. UEFI-Preferred: Modo de inicialização preferencial UEFI. Importante Para evitar falhas de inicialização, verifique os modos de inicialização suportados pela imagem antes de alterar seu modo de inicialização. Para mais informações, consulte Modos de inicialização. . Valores válidos: BIOS : BIOS. UEFI : UEFI. UEFI-Preferred : UEFI-Preferred.	BIOS
LicenseType	string	Não	O tipo de licença para ativar o sistema operacional após a importação da imagem. O único valor válido é BYOL. BYOL: Bring Your Own License (Traga sua própria licença). Se você usar o tipo de licença BYOL, deve garantir que sua chave de licença seja suportada para uso na Alibaba Cloud.	BYOL
Description	string	Não	A nova descrição da imagem personalizada. A descrição deve ter de 2 a 256 caracteres e não pode começar com http:// ou https://. Se você não especificar este parâmetro, a descrição original será mantida.	testDescription
Features	object	Não	Os recursos da imagem.
NvmeSupport	string	Não	Especifica se a imagem suporta NVMe. Valores válidos: supported: A imagem suporta NVMe. As instâncias criadas a partir desta imagem suportam o protocolo NVMe. unsupported: A imagem não suporta NVMe. As instâncias criadas a partir desta imagem não suportam o protocolo NVMe.	supported
ImdsSupport	string	Não	O modo de acesso a metadados da imagem. Valores válidos: v1: Ao criar uma instância ECS a partir desta imagem, você não pode definir o modo de acesso a metadados como enforced mode. v2: Ao criar uma instância ECS a partir desta imagem, você pode definir o modo de acesso a metadados como enforced mode. Importante Você não pode alterar o valor de ImdsSupport de v2 para v1. Para usar o modo v1, crie uma nova imagem a partir de um snapshot associado à imagem e defina ImdsSupport como v1. .	v2
DryRun	boolean	Não	Especifica se deve ser realizado um dry run para verificar se a solicitação é válida. Valores válidos: true: realiza um dry run para verificar a validade, a sintaxe e as permissões necessárias da solicitação. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro DryRunOperation será retornado. false (padrão): envia a solicitação. Se a solicitação passar nas verificações de validação, a operação será executada.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidImageName.Malformed	Image names must be between 2 and 128 characters long, using either English or Chinese characters. The name must start with a letter or a Chinese character, and can include numbers, colons, underscores and hyphens.	The length of the image name is 2 to 128 English or Chinese characters. It must start with an uppercase letter or a Chinese character and can contain numbers, colons (:), underscores (_), or dashes (-).
400	MissingParameter	The input parameter "RegionId" that is mandatory for processing this request is not supplied.
400	InvalidImageName.Duplicated	The specified Image name has already bean used.
400	InvalidDescription.Malformed	The specified description is wrongly formed.	The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	ImageQuotaFull.ImageFamily	The specified image family has exceeded max number of images for one image family.
400	InvalidImageFamily.Malformed	The specified parameter "ImageFamily" is malformed.
400	ImageFamilyQuotaFull	The specified region has exceeded max number of image family.
400	InvalidBootMode.NotSupport	The specified parameter BootMode is not supported.
400	InvalidLicenseType.NotSupported	The specified parameter LicenseType is not supported.
400	InvalidParameter.FeaturesImdsSupport	The specified parameter Features.ImdsSupport is not supported.	The specified parameter Features.ImdsSupport is not supported.
403	ImageStatus.NotAvailable	The specified image status is not available.
403	ImageStatus.NotDeprecated	The specified image status is not deprecated.	The specified image is not in the Deprecated state.
403	ImageUseShared	The specified image has been shared to others, please remove shared accounts first.
403	OperationDeined.ImageUsingByInstance	The boot mode of the image cannot be modified because it has associated instances.	The boot mode of the image cannot be modified while the image has associated instances.
403	InvalidOperation.FeaturesImdsSupportNotMatch	The specified parameter Features.ImdsSupport can not be set to v1 from v2.	The specified parameter Features.ImdsSupport can not be set to v1 from v2.
403	InvalidStatus.ImageIsCreating	The operation cannot be performed because the image is creating. Please wait until the creation is complete and try again.	The operation cannot be performed because the image is creating. Please wait until the creation is complete and try again.
403	InvalidOperation.PublicImageUnsupported	The community image's publisher is not the current account. Modification is not permitted.	The community image's publisher is not the current account. Modification is not permitted.
403	InvalidDescription.Malformed	The specified parameter description is not valid.	The specified parameter description is invalid.
404	InvalidImageId.NotFound	The specified ImageId does not exist.	The specified image does not exist in this account. Check whether the image ID is correct.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.