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

Modifica algumas propriedades de uma instância ECS, incluindo a senha, nome da instância, hostname, associação a grupos de segurança, MTU e dados de usuário da instância.

Descrição da operação

Instâncias bloqueadas por motivos de segurança não suportam esta operação. 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

*Instance

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

SecurityGroup

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 deve 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. A nova senha entra em vigor após você reiniciar a instância. Você pode reiniciar a instância no console do ECS (para mais informações, consulte Reiniciar uma instância) ou chamando RebootInstance. Reiniciar a instância de dentro do sistema operacional não entra em vigor. 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 hostname do sistema operacional. Observe os seguintes itens: A instância não pode estar no estado Pending ou Starting. Caso contrário, o hostname e a configuração `/etc/hosts` podem não entrar em vigor. Você pode chamar DescribeInstances para consultar o status atual da instância. O novo hostname entra em vigor após você reiniciar a instância. Você pode reiniciar a instância no console do ECS (para mais informações, consulte Reiniciar uma instância) ou chamando RebootInstance. Reiniciar a instância de dentro do sistema operacional não entra em vigor. O hostname possui os seguintes limites para diferentes sistemas operacionais: Windows Server: O hostname 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 hifen (-), não pode conter hifens consecutivos (-) e não pode conter apenas dígitos. Outras instâncias (como Linux): O hostname deve ter de 2 a 64 caracteres. Você pode usar pontos (.) para separar o hostname em múltiplos segmentos. Cada segmento pode conter letras maiúsculas, letras minúsculas, dígitos e hifens (-), mas não pode conter pontos consecutivos (.) ou hifens (-). O hostname não pode começar ou terminar com um ponto (.) ou hifen (-).	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 maiúscula, letra minúscula ou caractere chinês e não pode começar com `http://` ou `https://`. O nome pode conter dígitos, dois-pontos (:), underscores (_) 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 de usuário da instância. Recomendamos que você codifique os dados em Base64 antes de passá-los. Observe os seguintes itens: A instância deve atender aos limites de uso para dados de usuário da instância. Para mais informações, consulte Criar dados de usuário da instância. Após reiniciar a instância, os novos dados de usuário são exibidos na instância, mas não são executados. Nota Antes da codificação Base64, os dados brutos não podem exceder 32 KB. Não passe informações sensíveis como senhas e chaves privadas em texto simples. Se você precisar passar informações sensíveis, criptografe as informações, codifique-as em Base64 e depois descriptografe-as da mesma forma dentro da instância.	ZWNobyBoZWxsbyBlY3Mh
Recyclable	boolean	Não	Nota Este parâmetro está em preview 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 O que são 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 pelo console ou chamando DeleteInstance. Nota Este atributo se aplica apenas a instâncias pay-as-you-go e apenas previne operações de liberação manual. Não se aplica a operações de liberação iniciadas pelo sistema.	false
NetworkInterfaceQueueNumber	integer	Não	O número de filas para o controlador de interface de rede (NIC) primário. Observe os seguintes itens: A instância deve estar no estado Stopped. O valor não pode exceder o número máximo de filas por NIC permitido pelo tipo de instância. O número total de filas para todos os NICs na instância não pode exceder a cota total de filas permitida pelo tipo de instância. Você pode chamar 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 o NIC primário será redefinido para o valor padrão do tipo de instância. Você pode chamar DescribeInstanceTypes para consultar o número padrão de filas de Elastic Network Interface (ENI) para um tipo de instância.	8
SecurityGroupIds	array	Não	Os IDs dos grupos de segurança aos quais a instância será reatribuída. Observe os seguintes itens: Os IDs de grupos de segurança no array não podem ser duplicados. O comprimento máximo do array 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 sairá de seus grupos de segurança atuais. Para manter os grupos de segurança atuais, adicione seus IDs ao array. Você pode alternar entre tipos de grupos de segurança, mas a lista não pode conter grupos de segurança básicos e avançados ao mesmo tempo. Os grupos de segurança devem pertencer à mesma VPC que a instância. Nota As alterações nos grupos de segurança entram em vigor na instância logo após a modificação, mas um pequeno atraso pode ocorrer.	sg-bp15ed6xe1yxeycg7o****
	string	Não	O ID do grupo de segurança.	sg-bp15ed6xe1yxeycg7o****
RemoteConnectionOptions	object	Não	Nota Este parâmetro está em preview por convite e não está disponível publicamente.
Password	string	Não	Nota Este parâmetro está em preview por convite e não está disponível publicamente.	hide
Type	string	Não	Nota Este parâmetro está em preview por convite e não está disponível publicamente.	hide
EnableJumboFrame	boolean	Não	Especifica se o recurso Jumbo Frame deve ser ativado para o 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 ou Stopped. A instância deve ser uma instância conectada a VPC. Após o recurso Jumbo Frame ser ativado, o valor do MTU da instância muda para 8500. Após o recurso ser desativado, o valor do MTU reverte para 1500. Apenas alguns tipos de instância suportam o recurso Jumbo Frame. Para mais informações, consulte MTU de instância ECS.	false
CpuOptions.Core	integer	Não	O número de cores de CPU. Este parâmetro não suporta valores personalizados e só pode usar o valor padrão.	2
CpuOptions.ThreadsPerCore	integer	Não	O número de threads por core 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 do mesmo core na topologia de CPU são contínuos. DiscreteCoreToHTMapping: os hyper-threads do mesmo core são discretos. Valor padrão: nenhum. Observe os seguintes itens: A instância deve estar no estado Stopped. Nota Apenas algumas famílias de instância suportam este parâmetro. Para informações sobre as famílias de instância 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 resolução de domínio privado, consulte Resolução de domínio privado ECS.
EnableInstanceIdDnsARecord	boolean	Não	Especifica se a resolução DNS do nome de domínio baseado no ID da instância para o endereço IPv4 deve ser ativada. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
EnableInstanceIdDnsAAAARecord	boolean	Não	Especifica se a resolução DNS do nome de domínio baseado no ID da instância para o endereço IPv6 deve ser ativada. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
EnableIpDnsARecord	boolean	Não	Especifica se a resolução DNS do nome de domínio baseado em IP para o endereço IPv4 deve ser ativada. Valores válidos: true: ativa a resolução. false: desativa a resolução. Valor padrão: false.	false
EnableIpDnsPtrRecord	boolean	Não	Especifica se a resolução DNS reversa do endereço IPv4 para o nome de domínio baseado em IP deve ser ativada. 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 hostname. Valores válidos: Custom: personalizado. IpBased: hostname baseado em IP. InstanceIdBased: hostname baseado no ID da instância. Valor padrão: Custom.	Custom
CpuOptions	object	Não
NestedVirtualization	string	Não	Nota Este parâmetro está em preview por convite e não está disponível publicamente.	enabled
EnableNetworkEncryption	boolean	Não	Especifica se a criptografia de tráfego de rede VPC deve ser ativada. Valores válidos: true: ativa a criptografia. false: desativa a criptografia. Nota Este parâmetro está em preview 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 (.), underscores (_) ou hífens (-). Não pode começar com http:// ou https://.
400	InvalidDescription.Malformed	The specified parameter "Description" is not valid.	O parâmetro description especificado é inválido.
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 não oferece suporte a cloud-init.
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 desempenho especificado para instâncias burstable não é compatível 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 número máximo de grupos de segurança aos quais o recurso especificado pode ingressar foi atingido. Para mais informações, consulte o resultado real retornado do placeholder %s na mensagem de erro.
400	InvalidParameter	The specified parameter is not valid.	A combinação de parâmetros especificada é inválida.
400	InvalidOperation.InvalidEcsState	%s	O status atual da instância não suporta esta operação.
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 suporta a modificação do modo de computação criptografada.
400	InvalidParameter.CpuOptionsTopologyType	The specified parameter CpuOptions.TopologyType: %s is not valid.	O valor de enumeração do tipo de topologia de CPU atual é inválido.
400	InvalidInstanceType.NotSupportCpuOptionsTopologyType	The specified instance type does not support CpuOptions.TopologyType: %s.	O tipo de topologia de CPU especificado não é suportado pelo tipo de instância atual.
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 suporta o 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 status atual do recurso não suporta 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 confidencial baseado em GPU da instância é inválido.
400	InvalidParameterAuthorized.GpuOptionsConfidentialComputing	The specified parameter confidential computing mode is unauthorized.	O valor do parâmetro de modo de computação confidencial baseado em 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 atual não suporta a capacidade de virtualização aninhada especificada.
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 está bloqueada por motivos de segurança. Entre em contato com o suporte técnico de segurança.
403	OperationDenied	The instance amount in the specified SecurityGroup reach its limit.	O EIP especificado está indisponível ou não autorizado.
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 parâmetro UserData especificado deve ser codificado em Base64.
403	InvalidChargeType.ValueNotSupported	Deletion protection is only valid for postPaid instance, not for prePaid or spot instance.	O recurso de proteção contra exclusão pode ser usado apenas para recursos pay-as-you-go.
403	InvalidUser.Unauthorized	The user is not authorized	A conta que você está usando não possui 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 vários tipos de grupos de segurança.
403	SecurityGroupInstanceLimitExceed	%s	O número de instâncias no grupo de segurança atingiu o limite máximo.
403	InstanceNotInSecurityGroup	The instance not in the group.
403	InvalidOperation.InvalidRegion	%s
403	InvalidOperation.ResourceManagedByCloudProduct	%s	Esta operação não é suportada porque o recurso é gerenciado por um serviço em nuvem. Entre em contato com o serviço em nuvem correspondente para confirmar o motivo.
403	InvalidParameter.InvalidEniQueueNumber	%s	O número de filas do controlador de interface de rede (NIC) está incorreto. Para mais informações, consulte o resultado real retornado do placeholder %s na mensagem de erro.
403	InvalidOperation.MaxEniQueueNumberExceeded	%s	O número de filas da Elastic Network Interface (ENI) excede o limite máximo. Para mais informações, consulte o resultado real retornado do placeholder %s na mensagem de erro.
403	InvalidOperation.ExceedInstanceTypeQueueNumber	%s	O número total de filas da Elastic Network Interface (ENI) excede o limite superior. Para mais informações, consulte o valor de retorno real do placeholder %s na mensagem de erro.
403	InvalidOperation.InstanceTypeNotSupportHighPerformanceTrafficMode	%s	O tipo de instância atual não suporta a anexação de ENIs habilitadas para 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 suporta a 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.	O ID da instância especificado é inválido.
404	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	O grupo de segurança especificado não existe.
404	Credit.NotFound	The specified credit information does not exist.	As informações de crédito 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 está duplicado.
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.