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

Modifica algumas propriedades de uma instância ECS, como a senha, o nome da instância, o nome do host, os grupos de segurança, a MTU e os dados do usuário da instância.

Descrição da operação

Você não pode chamar esta operação em uma instância bloqueada por segurança. Para mais informações, consulte Impacto dos bloqueios de segurança de recursos nas chamadas de API.

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

update

*Instância.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Grupo de segurança.

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

ecs:tag
ecs:PasswordCustomized

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	i-bp67acfmxazb4ph****
Password	string	Não	A senha da instância. A senha deve ter de 8 a 30 caracteres e conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Os seguintes caracteres especiais são suportados: *()`~!@#$%^&-_+=\|{}[]:;'<>,.?/. Para instâncias Windows, a senha não pode começar com uma barra (/). Observe os seguintes itens: A instância não pode estar no estado Starting (Starting). A nova senha entra em vigor após a reinicialização da instância. Você pode reiniciar a instância no console ECS (para mais informações, consulte Reiniciar uma instância) ou chamando a operação RebootInstance. Reiniciar a instância a partir do sistema operacional não surte efeito. Nota** Se você especificar o parâmetro Password, use HTTPS para enviar a solicitação e evitar vazamentos de senha.	Test123456&$
HostName	string	Não	O nome do host do sistema operacional. Observe os seguintes itens: A instância não pode estar no estado Pending (Pending) ou Starting (Starting). Caso contrário, o nome do host e a configuração do /etc/hosts podem não entrar em vigor. Você pode chamar a operação DescribeInstances para consultar o status atual da instância. O novo nome do host entra em vigor após a reinicialização da instância. Você pode reiniciar a instância no console ECS (para mais informações, consulte Reiniciar uma instância) ou chamando a operação RebootInstance. Reiniciar a instância a partir do sistema operacional não surte efeito. O nome do host tem os seguintes limites para diferentes sistemas operacionais: Windows Server: O nome do host deve ter de 2 a 15 caracteres e pode conter letras maiúsculas, letras minúsculas, dígitos e hifens (-). Não pode começar ou terminar com um hífen (-), conter hifens consecutivos (-) ou conter apenas dígitos. Outras instâncias (como Linux): O nome do host deve ter de 2 a 64 caracteres. Você pode usar pontos (.) para separar um nome de host em vários segmentos. Cada segmento pode conter letras maiúsculas, letras minúsculas, dígitos e hifens (-). Pontos (.) ou hifens (-) consecutivos não são permitidos. O nome do host não pode começar ou terminar com um ponto (.) ou um hífen (-).	testHostName
InstanceName	string	Não	O nome da instância. O nome deve ter de 2 a 128 caracteres. Deve começar com uma letra e não pode começar com http:// ou https://. O nome pode conter dígitos, dois-pontos (:), sublinhados (_) e hifens (-).	testInstanceName
Description	string	Não	A descrição da instância. A descrição deve ter de 2 a 256 caracteres e não pode começar com http:// ou https://.	testInstanceDescription
UserData	string	Não	Os dados do usuário da instância. Recomendamos que você codifique os dados em Base64 antes de transmiti-los. Observe os seguintes itens: A instância deve atender aos limites de dados do usuário da instância. Para mais informações, consulte Criar dados do usuário da instância. Após reiniciar a instância, os novos dados do usuário são exibidos na instância, mas não são executados. Nota Antes da codificação em Base64, os dados brutos não podem exceder 32 KB. Não transmita informações confidenciais, como senhas e chaves privadas, em texto simples. Se for necessário transmitir informações confidenciais, criptografe as informações, codifique-as em Base64 e, em seguida, descriptografe-as da mesma maneira dentro da instância.	ZWNobyBoZWxsbyBlY3Mh
Recyclable	boolean	Não	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	true
CreditSpecification	string	Não	O modo de execução da instância burstable. Valores válidos: Standard: modo padrão. Unlimited: modo ilimitado. Para mais informações sobre os modos de execução de instâncias burstable, consulte Visão geral das instâncias burstable.	Standard
DeletionProtection	boolean	Não	O atributo de proteção contra liberação da instância. Especifica se a instância pode ser liberada a partir do console ou chamando a operação DeleteInstance. Nota Este atributo é aplicável apenas a instâncias pay-as-you-go. Ele pode apenas impedir a liberação manual, não a liberação iniciada pelo sistema.	false
NetworkInterfaceQueueNumber	integer	Não	O número de filas para a Elastic Network Interface (ENI) primária. Observe os seguintes itens: A instância deve estar no estado Stopped (Stopped). O valor não pode exceder o número máximo de filas por controlador de interface de rede (NIC) permitido pelo tipo de instância. O número total de filas para todas as NICs na instância não pode exceder a cota de filas permitida pelo tipo de instância. Você pode chamar a operação DescribeInstanceTypes para consultar o número máximo de filas por NIC e a cota total de filas para um tipo de instância. Se você definir este parâmetro como -1, o número de filas para a ENI primária será redefinido para o valor padrão do tipo de instância. Você pode chamar a operação DescribeInstanceTypes para consultar o número padrão de filas por ENI para um tipo de instância.	8
SecurityGroupIds	array	Não	Os IDs dos grupos de segurança aos quais a instância é reatribuída. Observe os seguintes itens: Os IDs dos grupos de segurança na matriz devem ser exclusivos. O comprimento máximo da matriz depende do número máximo de grupos de segurança aos quais a instância pode pertencer. Para mais informações, consulte Limites. A instância é removida dos grupos de segurança atuais. Para reter os grupos de segurança atuais, adicione seus IDs à matriz. Você pode alternar o tipo de grupo de segurança, mas a lista não pode conter grupos de segurança básicos e grupos de segurança avançados ao mesmo tempo. Os grupos de segurança devem pertencer à mesma VPC que a instância. Nota As alterações entram em vigor na instância logo após a modificação, mas pode ocorrer um leve atraso.	sg-bp15ed6xe1yxeycg7o****
	string	Não	O ID do grupo de segurança.	sg-bp15ed6xe1yxeycg7o****
RemoteConnectionOptions	object	Não	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.
Password	string	Não	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	hide
Type	string	Não	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	hide
EnableJumboFrame	boolean	Não	Especifica se deve ser ativado o recurso Jumbo Frame para a MTU da instância. Valores válidos: true: ativa o recurso. false: não ativa o recurso. Observe os seguintes itens: A instância deve estar no estado Running (Running) ou Stopped (Stopped). A instância deve ser uma instância conectada à VPC. Após a ativação do recurso Jumbo Frame, o valor da MTU da instância é alterado para 8500. Após a desativação do recurso, o valor da MTU é revertido para 1500. Apenas alguns tipos de instância suportam o recurso Jumbo Frame. Para mais informações, consulte MTU da instância ECS.	false
CpuOptions.Core	integer	Não	O número de núcleos de CPU. Este parâmetro não suporta valores personalizados e pode usar apenas o valor padrão.	2
CpuOptions.ThreadsPerCore	integer	Não	O número de threads por núcleo de CPU. O número de vCPUs da instância ECS = valor de CpuOptions.Core × valor de CpuOptions.ThreadsPerCore. CpuOptions.ThreadsPerCore=1 indica que o hyper-threading está desativado. Apenas alguns tipos de instância suportam contagens de threads personalizadas.	2
CpuOptions.TopologyType	string	Não	O tipo de topologia de CPU da instância. Valores válidos: ContinuousCoreToHTMapping: Os hyper-threads (HTs) dentro do mesmo núcleo da topologia de CPU da instância são contínuos. DiscreteCoreToHTMapping: Os HTs dentro do mesmo núcleo são discretos. Valor padrão: none. Observe os seguintes itens: A instância deve estar no estado Stopped (Stopped). Nota Apenas algumas famílias de instâncias suportam este parâmetro. Para obter informações sobre as famílias de instâncias suportadas, consulte Visualizar e modificar a estrutura de topologia de CPU.	DiscreteCoreToHTMapping
PrivateDnsNameOptions	object	Não	A configuração de nome de domínio privado da instância. Para mais informações sobre a resolução de domínio privado, consulte Resolução de domínio privado do ECS.
EnableInstanceIdDnsARecord	boolean	Não	Especifica se deve ser ativada a resolução de registro DNS A do nome de domínio baseado no ID da instância para o endereço IPv4. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
EnableInstanceIdDnsAAAARecord	boolean	Não	Especifica se deve ser ativada a resolução de registro DNS AAAA do nome de domínio baseado no ID da instância para o endereço IPv6. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
EnableIpDnsARecord	boolean	Não	Especifica se deve ser ativada a resolução de registro DNS A do nome de domínio baseado em IP para o endereço IPv4. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
EnableIpDnsPtrRecord	boolean	Não	Especifica se deve ser ativada a resolução reversa de registro DNS PTR do endereço IPv4 para o nome de domínio baseado em IP. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
HostnameType	string	Não	O tipo de nome do host. Valores válidos: Custom: nome do host personalizado. IpBased: nome do host baseado em IP. InstanceIdBased: nome do host baseado no ID da instância. Valor padrão: Custom.	Custom
CpuOptions	object	Não	As opções de CPU.
NestedVirtualization	string	Não	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente. Valores válidos: disabled : Desativada. enabled : Ativada.	enabled
EnableNetworkEncryption	boolean	Não	Especifica se deve ser ativada a criptografia de tráfego de rede da VPC. Valores válidos: true: ativa a criptografia. false: desativa a criptografia. Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidInstanceName.Malformed	The specified parameter "InstanceName" is not valid.	O formato do nome da instância especificado é inválido. O nome deve ter de 2 a 128 caracteres e deve começar com uma letra ou um caractere chinês. Pode conter dígitos, pontos (.), sublinhados (_) ou hifens (-). Não pode começar com http:// ou https://.
400	InvalidDescription.Malformed	The specified parameter "Description" is not valid.	The formato specified resource description format is invalid. The description must be to to 2 to to characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters [ in[ec charactersec
400	InvalidRemoteConnectionOptions.Password	The remote connection password is invalid.
400	InvalidRemoteConnectionOptions.Type	The remote connection type is invalid.
400	InstanceType.ValueNotSupported	The instance type not supported.
400	OSType.ValueNotSupported	The OS type is not supported.
400	InvalidHostPassword.Malformed	The specified parameter "Password" is not valid.
400	InvalidHostName.Malformed	The specified parameter "HostName" is not valid.	O parâmetro HostName especificado é inválido.
400	InvalidPassword.Malformed	The specified parameter "Password" is not valid.	O parâmetro Password especificado é inválido.
400	InvalidUserData.SizeExceeded	The specified parameter "UserData" exceeds the size.
400	InvalidUserData.NotSupported	TThe specified parameter "UserData" only support the vpc and IoOptimized Instance.
400	ImageNotSupportCloudInit	The specified image does not support cloud-init.	A imagem especificada não suporta CloudInit.
400	ChargeTypeViolation	Pay-As-You-Go instances do not support this operation.
400	InvalidParameter.RecycleBin	You do not have permission to set recyclable properties.	Você não está autorizado a realizar esta operação.
400	InvalidParameter.CreditSpecification	The specified CreditSpecification is not supported in this region.	O modo de execução especificado da instância burstable não é suportado nesta região.
400	InvalidInstanceStatus.CreditSpecRestricted	The current status of the resource does not support this operation.	O estado atual do recurso não suporta esta operação.
400	InvalidInstanceStatus.NotRunning	The current status of the resource is invalid, you can only do this operation when instance is running.	O status atual da instância não suporta esta operação. Execute esta operação quando o status da instância for Running.
400	InvalidNetworkType.NotSupported	The classic networkType does not support to modify security group
400	InvalidOperation.EniCountExceeded	=The maximum number of eni in a enterprise security group is exceeded.
400	JoinedGroupLimitExceed	%s	O recurso especificado atingiu o número máximo de grupos de segurança aos quais pode ser associado. Para mais informações, consulte o resultado de retorno real do placeholder %s na mensagem de erro.
400	InvalidParameter	The specified parameter is not valid.	Os parâmetros da solicitação atual são inválidos. Tente novamente.
400	InvalidOperation.InvalidEcsState	%s	Esta operação não é permitida no status atual do serviço de nuvem.
400	InvalidParam.NotSupportJumboFrame	Not support jumbo frame.
400	InvalidOperation.InstanceStatusNotSupport	The instance status is not support modify mtu config.
400	InvalidOperation.InstanceStatusUnsupported	The specified instance status does not support modification of cpu topology type.	O status atual da instância não oferece suporte à modificação do tipo de topologia de CPU.
400	InvalidParameter.CpuOptionsTopologyType	The specified parameter CpuOptions.TopologyType: %s is not valid.	O valor do tipo de topologia de CPU especificado é inválido.
400	InvalidInstanceType.NotSupportCpuOptionsTopologyType	The specified instance type does not support CpuOptions.TopologyType: %s.	O tipo de instância atual não oferece suporte ao tipo de topologia de CPU especificado.
400	InvalidAdditionalInfoPvdConfig.SizeExceeded	The specified parameter AdditionalInfo.PvdConfig exceeds the size.
400	InvalidInstanceType.NotSupportHighDensityMode	The specified instance type does not support the use of the high density mode.	O tipo de instância atual não oferece suporte ao modo de disco de alta densidade.
400	InvalidStatus.StoppedRequired	The current state of the resource does not support this operation, it can only be operated in a stopped state.	O estado atual do recurso não oferece suporte a esta operação. O recurso deve estar no estado Stopped.
400	InvalidParameter.CpuOptionsTurboMode	The specified parameter TurboMode is not valid.	O parâmetro de modo de frequência especificado é inválido.
400	InvalidInstanceType.EnableNVSUnsupported	The specified instance type does not support EnableNVS.	O tipo de instância especificado não suporta a ativação do recurso NVS.
400	InvalidInstanceType.EnableVISSTUnsupported	The specified instance type does not support EnableVISST.	O tipo de instância especificado não suporta a ativação do recurso VISST.
400	InvalidInstanceType.EnableVRDTUnsupported	The specified instance type does not support EnableVRDT.	O tipo de instância especificado não suporta a ativação do recurso VRDT.
400	InvalidInstanceType.SingleCoreMaxModeUnsupported	The specified instance type does not support TurboMode: "SINGLE CORE MAX".	O tipo de instância especificado não suporta a ativação do modo de frequência turbo máxima de núcleo único.
400	InvalidInstanceType.GpuOptionsConfidentialComputingUnsupported	The specified instance type does not support the confidential computing mode.
400	InvalidParameter.GpuOptionsConfidentialComputing	The specified parameter confidential computing mode is not valid.	O valor de enumeração para o modo de computação criptografada da GPU da instância é inválido.
400	InvalidParameterAuthorized.GpuOptionsConfidentialComputing	The specified parameter confidential computing mode is unauthorized.	O valor do parâmetro do modo de computação criptografada da GPU especificado para a instância não está autorizado.
400	InvalidParameter.CpuOptionsNestedVirtualization	The specified parameter CpuOptions.NestedVirtualization: %s is not valid.
400	InvalidInstanceType.NotSupportCpuOptionsNestedVirtualization	The specified instance type does not support CpuOptions.NestedVirtualization: %s.	O tipo de instância especificado não oferece suporte ao recurso de virtualização aninhada especificado.
500	InternalError	The request processing has failed due to some unknown error.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	InstanceLockedForSecurity	The specified operation is denied as your instance is locked for security reasons.	A instância à qual o disco está anexado está bloqueada por motivos de segurança.
403	OperationDenied	The instance amount in the specified SecurityGroup reach its limit.	O snapshot especificado não permite a criação de volumes de dados.
403	InvalidUserData.Forbidden	User not authorized to input the parameter "UserData"please apply for permission "UserData"
403	InvalidUserData.Base64FormatInvalid	The specified UserData is not valid	O UserData especificado é inválido.
403	InvalidChargeType.ValueNotSupported	Deletion protection is only valid for postPaid instance, not for prePaid or spot instance.	O método de cobrança da instância não suporta a operação especificada.
403	InvalidUser.Unauthorized	The user is not authorized	A conta atual não tem as permissões necessárias.
403	EnterpriseGroupLimited.MutliGroupType	The specified instance can not join multi SecurityGroup types.	A instância especificada não pode ser adicionada a um grupo de segurança personalizado e a um grupo de segurança avançado ao mesmo tempo. Você pode chamar DescribeSecurityGroups para consultar o tipo do grupo de segurança especificado.
403	SecurityGroupInstanceLimitExceed	%s	O número máximo de instâncias no grupo de segurança foi atingido.
403	InstanceNotInSecurityGroup	The instance not in the group.
403	InvalidOperation.InvalidRegion	%s
403	InvalidOperation.ResourceManagedByCloudProduct	%s	Os grupos de segurança gerenciados por serviços de nuvem não suportam operações de modificação.
403	InvalidParameter.InvalidEniQueueNumber	%s	O número de filas de Elastic Network Interface (ENI) no controlador de interface de rede (NIC) está incorreto. Para mais informações, consulte o resultado de retorno real do placeholder %s na mensagem de erro.
403	InvalidOperation.MaxEniQueueNumberExceeded	%s	O número de filas de Elastic Network Interface (ENI) no controlador de interface de rede (NIC) excede o limite superior. Para mais informações, consulte o resultado de retorno real do placeholder %s na mensagem de erro.
403	InvalidOperation.ExceedInstanceTypeQueueNumber	%s	O número total de filas de Elastic Network Interface (ENI) no controlador de interface de rede (NIC) excede o limite superior. Para mais informações, consulte o resultado de retorno real do placeholder %s na mensagem de erro.
403	InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode	%s	O tipo de instância da instância especificada não oferece suporte a ENIs no modo RDMA.
403	InvalidParameter.InvalidQueuePairNumber	%s
403	InvalidOperation.MaxEniQueuePairNumberExceed	%s
403	InvalidOperation.EniQueuePairNumberOverflow	%s
403	AclLimitExceed	%s	O número de regras de grupo de segurança para a ENI ou instância excede a cota.
403	InvalidInstanceType.CpuOptionsThreadsPerCoreUnsupported	The current instance type does not support setting or modifying the CpuOptions.ThreadsPerCore parameter.	O tipo de instância atual não oferece suporte à definição ou modificação do parâmetro CpuOptions.ThreadsPerCore.
403	InvalidParameter.CpuOptionsCore	The specified parameter CpuOptions.Core is not valid.	O parâmetro CpuOptions.Core é inválido.
403	InvalidParameter.CpuOptionsThreadsPerCore	The specified parameter CpuOptions.ThreadsPerCore is not valid.	O parâmetro CpuOptions.ThreadsPerCore é inválido.
403	InvalidOperation.UserNotSupportNetworkEncryption	User not support network encryption.	O usuário não suporta a especificação de parâmetros de criptografia de tráfego de rede.
403	InvalidOperation.InstanceTypeNotSupportNetworkEncryption	The specified instance type does not support network encryption.	O tipo de instância especificado não suporta criptografia de tráfego VPC.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instance instance does not. Check.[ec2478.desc]O InstanceType parameter is required.
404	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	O grupo de segurança especificado não existe na sua conta. Verifique se o ID do grupo de segurança está correto.
404	Credit.NotFound	The specified credit information does not exist.	As informações de crédito de CPU da instância burstable especificada não existem.
404	InvalidInstanceStatus.NeedRestart	The current status of the resource is invalid, you can only do this operation after instance is restarted.
404	InvalidParameter.SecurityGroupIdRepeated	The specified security group ids has repeated.	O grupo de segurança especificado já foi adicionado. Verifique se o valor do parâmetro SecurityGroupIds está correto.
404	InvalidSecurityGroupType.NotSupportClassic	The specified SecurityGroupIds have classic group type.	O tipo de rede do grupo de segurança especificado é rede clássica. Verifique se o valor do parâmetro SecurityGroupIds está correto.
404	InvalidSecurityGroupVpc.NotBelongToOneVpc	The specified SecurityGroupIds are belong to different vpc.	Os IDs de grupo de segurança especificados pertencem a VPCs diferentes. Verifique se o valor do parâmetro SecurityGroupIds está correto. Você pode chamar DescribeSecurityGroups para consultar a VPC à qual o grupo de segurança especificado pertence.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.