ModifyInstanceAttribute - - Centre de documentation Alibaba Cloud

Modifiez les attributs d'une instance Elastic Compute Service (ECS), tels que le mot de passe, le nom, la description, le nom d'hôte, le groupe de sécurité, l'unité maximale de transmission (MTU) et les données utilisateur. Si l'instance est une instance à performances variables, vous pouvez également modifier son mode de performance.

Notes d'utilisation

Si la réponse contient {"OperationLocks": {"LockReason" : "security"}} lorsque vous interrogez les informations d'une instance, celle-ci est verrouillée pour des raisons de sécurité. Aucune opération n'est autorisée sur cette instance.

Tenez compte des points suivants :

Modification du nom d'hôte (HostName) : après avoir modifié le nom d'hôte, redémarrez l'instance dans la console ECS ou en appelant l'opération RebootInstance pour que la modification prenne effet. Pour savoir comment redémarrer une instance dans la console ECS, consultez la rubrique Restart instances. Le nouveau nom d'hôte ne prend pas effet si vous redémarrez l'instance depuis le système d'exploitation.
Réinitialisation du mot de passe (Password) :
- L'instance ne doit pas être dans l'état Starting (Starting).
- Après avoir réinitialisé le mot de passe, redémarrez l'instance dans la console ECS ou en appelant l'opération RebootInstance pour que le nouveau mot de passe prenne effet. Pour savoir comment redémarrer une instance dans la console ECS, consultez la rubrique Restart instances. Le nouveau mot de passe ne prend pas effet si vous redémarrez l'instance depuis le système d'exploitation.
Modification des données utilisateur (UserData) :
- L'instance doit être dans l'état Stopped (Stopped).
- L'instance doit respecter les limites applicables aux données utilisateur. Pour plus d'informations, consultez la rubrique Prepare user data.
  
  Remarque
  Après le redémarrage de l'instance, les nouvelles données utilisateur s'affichent mais ne sont pas exécutées en tant que scripts.
Modification des groupes de sécurité (SecurityGroupIds.N) :
- Vous pouvez déplacer une instance vers un groupe de sécurité d'un type différent.
  
  Si vous souhaitez déplacer une instance vers un groupe de sécurité d'un type différent, familiarisez-vous avec les différences entre les configurations de règles des deux types de groupes de sécurité afin d'éviter tout impact sur le réseau de l'instance.
- Les groupes de sécurité des instances du réseau classique ne peuvent pas être modifiés.
  
  Pour plus d'informations, consultez la description du paramètre SecurityGroupIds.N.
Modification du nombre de files d'attente prises en charge par l'interface réseau élastique (ENI) principale (NetworkInterfaceQueueNumber) :
- L'instance doit être dans l'état Stopped (Stopped).
- La valeur de ce paramètre ne peut pas dépasser le nombre maximal de files d'attente autorisé par ENI.
- Le nombre total de files d'attente pour toutes les ENI de l'instance ne peut pas dépasser le quota de files d'attente pour le type d'instance. Pour obtenir le nombre maximal de files d'attente par ENI et le quota de files d'attente pour un type d'instance, appelez l'opération DescribeInstanceTypes afin d'interroger les valeurs MaximumQueueNumberPerEni et TotalEniQueueQuantity.
- Si vous définissez ce paramètre sur -1, la valeur est réinitialisée à la valeur par défaut pour le type d'instance. Pour obtenir le nombre par défaut de files d'attente prises en charge par l'ENI principale pour un type d'instance, appelez l'opération DescribeInstanceTypes afin d'interroger la valeur PrimaryEniQueueNumber.
Activation ou désactivation de la fonctionnalité Jumbo Frames (EnableJumboFrame) : pour plus d'informations, consultez la rubrique MTUs.
- L'instance doit être dans l'état Running (Running) ou Stopped (Stopped).
- L'instance doit résider dans un VPC (Virtual Private Cloud).
- Une fois la fonctionnalité Jumbo Frames activée, la valeur MTU de l'instance est définie sur 8500. Une fois la fonctionnalité Jumbo Frames désactivée, la valeur MTU de l'instance est définie sur 1500.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyInstanceAttribute	Opération à effectuer. Définissez la valeur sur ModifyInstanceAttribute.
InstanceId	String	Yes	i-bp67acfmxazb4ph****	ID de l'instance.
Password	String	No	Test123456	Mot de passe de l'instance. Le mot de passe doit comporter entre 8 et 30 caractères et contenir au moins trois des types de caractères suivants : lettres majuscules, lettres minuscules, chiffres et caractères spéciaux. Les caractères spéciaux incluent : ( ) ` ~ ! @ # $ % ^ & * - _ + = \| { } [ ] : ; ' < > , . ? / Pour les instances Windows, les mots de passe ne peuvent pas commencer par une barre oblique (/). Remarque Pour des raisons de sécurité, nous vous recommandons d'utiliser HTTPS pour envoyer des requêtes si `Password` est spécifié.
HostName	String	No	testHostName	Nom d'hôte de l'instance. Tenez compte des points suivants : Lorsque vous modifiez le nom d'hôte de l'instance, celle-ci ne doit pas être dans l'état Creating (`Pending`) ou Starting (`Starting`). Sinon, le nouveau nom d'hôte et les configurations dans `/etc/hosts` risquent de ne pas prendre effet. Vous pouvez appeler l'opération DescribeInstances pour interroger l'état de l'instance. Après avoir modifié le nom d'hôte, vous devez appeler l'opération RebootInstance pour que le nouveau nom d'hôte prenne effet. Les limites suivantes s'appliquent aux noms d'hôte des instances exécutant différents systèmes d'exploitation : Pour Windows Server, le nom d'hôte doit comporter entre 2 et 15 caractères et peut contenir des lettres, des chiffres et des traits d'union (-). Le nom d'hôte ne peut pas commencer ou se terminer par un trait d'union (-), contenir des traits d'union (-) consécutifs ou être composé uniquement de chiffres. Pour les autres systèmes d'exploitation tels que Linux, le nom d'hôte doit comporter entre 2 et 64 caractères. Vous pouvez utiliser des points (.) pour séparer un nom d'hôte en plusieurs segments. Chaque segment peut contenir des lettres, des chiffres et des traits d'union (-). Le nom d'hôte ne peut pas contenir de points (.) ou de traits d'union (-) consécutifs. Le nom d'hôte ne peut pas commencer ou se terminer par un point (.) ou un trait d'union (-).
InstanceName	String	No	testInstanceName	Nom de l'instance. Le nom doit comporter entre 2 et 128 caractères. Il doit commencer par une lettre et ne peut pas commencer par `http://` ou `https://`. Le nom peut contenir des lettres, des chiffres, des deux-points (:), des traits de soulignement (_) et des traits d'union (-).
Description	String	No	testInstanceDescription	Description de l'instance. La description doit comporter entre 2 et 256 caractères et ne peut pas commencer par `http://` ou `https://`.
UserData	String	No	ZWNobyBoZWxsbyBlY3Mh	Données utilisateur de l'instance. Les données utilisateur doivent être encodées en Base64. La taille des données utilisateur ne peut pas dépasser 16 Ko avant l'encodage en Base64. Nous vous déconseillons de transmettre en texte clair des informations confidentielles telles que des mots de passe et des clés privées. Si vous devez transmettre des informations confidentielles, nous vous recommandons de les chiffrer et de les encoder en Base64 avant de les transmettre. Vous pouvez ensuite décoder et déchiffrer les informations de la même manière au sein de l'instance.
Recyclable	Boolean	No	hide	Remarque Ce paramètre est en aperçu sur invitation et n'est pas disponible publiquement.
CreditSpecification	String	No	Standard	Mode de performance de l'instance à performances variables. Valeurs possibles : Standard Unlimited Pour plus d'informations sur les modes de performance des instances à performances variables, consultez la rubrique Overview.
DeletionProtection	Boolean	No	false	Attribut de protection contre la suppression de l'instance. Ce paramètre indique si vous pouvez utiliser la console ECS ou appeler l'opération DeleteInstance pour libérer l'instance. Remarque Ce paramètre s'applique uniquement aux instances en paiement à l'utilisation. L'attribut de protection contre la suppression protège les instances contre les suppressions manuelles, mais pas contre les suppressions automatiques.
NetworkInterfaceQueueNumber	Integer	No	8	Nombre de files d'attente prises en charge par l'ENI principale.
SecurityGroupIds.N	String	No	sg-bp15ed6xe1yxeycg7o****	ID des groupes de sécurité de remplacement. L'ID du groupe de sécurité doit être unique. L'instance est déplacée des groupes de sécurité actuels vers les groupes de sécurité de remplacement. Si vous souhaitez que l'instance reste dans les groupes de sécurité actuels, ajoutez les ID des groupes de sécurité actuels à la liste. Vous pouvez déplacer l'instance vers des groupes de sécurité d'un type différent. Toutefois, la liste ne peut pas contenir à la fois les ID de groupes de sécurité basiques et avancés. Le groupe de sécurité spécifié et l'instance doivent appartenir au même VPC. Les valeurs valides de N sont basées sur le nombre maximal de groupes de sécurité auxquels l'instance peut appartenir. Pour plus d'informations, consultez la rubrique Limits. Les nouveaux groupes de sécurité deviennent valides pour l'instance après une courte latence.
RemoteConnectionOptions.Password	String	No	hide	Remarque Ce paramètre est en aperçu sur invitation et n'est pas disponible publiquement.
RemoteConnectionOptions.Type	String	No	hide	Remarque Ce paramètre est en aperçu sur invitation et n'est pas disponible publiquement.
EnableJumboFrame	Boolean	No	false	Indique s'il faut activer la fonctionnalité Jumbo Frames pour l'instance. Valeurs possibles : true false Vous pouvez activer la fonctionnalité Jumbo Frames uniquement pour certains types d'instance. Pour plus d'informations, consultez la rubrique MTUs.
CpuOptions.TopologyType	String	No	DiscreteCoreToHTMapping	Type de topologie CPU de l'instance. Valeurs possibles : ContinuousCoreToHTMapping : la technologie Hyper-Threading (HT) permet à des threads continus de s'exécuter sur le même cœur dans la topologie CPU de l'instance. DiscreteCoreToHTMapping : la technologie HT permet à des threads discrets de s'exécuter sur le même cœur dans la topologie CPU de l'instance. Ce paramètre est vide par défaut. Remarque Ce paramètre est pris en charge uniquement par certaines familles d'instances. Pour plus d'informations sur les familles d'instances prises en charge, consultez la rubrique View and modify the CPU topology. Avant de spécifier ce paramètre, assurez-vous que l'instance est dans l'état Stopped (`Stopped`).

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID de la requête.

Exemples

Exemples de requêtes

https://ecs.aliyuncs.com/?Action=ModifyInstanceAttribute
&InstanceId=i-bp67acfmxazb4ph****
&Action=ModifyInstanceAttribute
&CreditSpecification=Standard
&DeletionProtection=false
&Description=testInstanceDescription
&HostName=testHostName
&InstanceName=testInstanceName
&Password=Test123456
&SecurityGroupIds.1=sg-bp15ed6xe1yxeycg7o****
&SecurityGroupIds.2=sg-bp15ed6xe1yxeycg7p****
&SecurityGroupIds.3=sg-bp15ed6xe1yxeycg7q****
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyInstanceAttributeResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</ModifyInstanceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	InvalidInstanceName.Malformed	The specified parameter "InstanceName" is not valid.	Valeur InstanceName non valide.
400	InvalidDescription.Malformed	The specified parameter "Description" is not valid.	Format Description non valide. Le nom doit comporter entre 2 et 256 caractères et ne peut pas commencer par http:// ou https://.
400	ImageNotSupportCloudInit	The specified image does not support cloud-init.	L'image spécifiée ne prend pas en charge cloud-init.
400	ChargeTypeViolation	Pay-As-You-Go instances do not support this operation.	L'opération ne peut pas être effectuée sur les instances en paiement à l'utilisation. Vérifiez la méthode de facturation de l'instance.
400	InvalidParameter.RecycleBin	You do not have permission to set recyclable properties.	Vous n'êtes pas autorisé à effectuer cette opération.
400	InvalidParameter.CreditSpecification	The specified CreditSpecification is not supported in this region.	La spécification de crédit spécifiée n'est pas prise en charge dans cette région.
400	InvalidInstanceStatus.CreditSpecRestricted	The current status of the resource does not support this operation.	Cette opération ne peut pas être effectuée sur la ressource dans l'état actuel.
400	InvalidInstanceStatus.NotRunning	The current status of the resource is invalid, you can only do this operation when instance is running.	Cette opération ne peut pas être effectuée sur l'instance dans l'état actuel. Réessayez lorsque l'instance est dans l'état Running.
400	JoinedGroupLimitExceed	%s	Le nombre maximal de groupes de sécurité auxquels la ressource spécifiée peut être attribuée est dépassé. Pour plus d'informations, consultez la valeur renvoyée par l'espace réservé %s dans le message d'erreur.
400	InvalidParameter	The specified parameter is not valid.	Un paramètre spécifié n'est pas valide.
400	InvalidOperation.InvalidEcsState	%s	Cette opération ne peut pas être effectuée sur l'instance dans l'état actuel.
400	InvalidOperation.InstanceStatusUnsupported	The specified instance status does not support modification of cpu topology type.	La topologie CPU ne peut pas être modifiée pour l'instance dans l'état actuel.
400	InvalidParameter.CpuOptionsTopologyType	The specified parameter CpuOptions.TopologyType: %s is not valid.	La valeur d'énumération du type de topologie CPU actuel n'est pas valide.
400	InvalidInstanceType.NotSupportCpuOptionsTopologyType	The specified instance type does not support CpuOptions.TopologyType: %s.	Le type d'instance ne prend pas en charge la topologie CPU spécifiée.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.	Cette opération ne peut pas être effectuée sur la ressource dans l'état actuel.
403	InstanceLockedForSecurity	The specified operation is denied as your instance is locked for security reasons.	L'instance est verrouillée pour des raisons de sécurité.
403	OperationDenied	The instance amount in the specified SecurityGroup reach its limit.	Le nombre maximal d'instances dans le groupe de sécurité spécifié est dépassé.
403	OperationDenied	The current status of the resource does not support this operation.	Cette opération ne peut pas être effectuée sur la ressource dans l'état actuel.
403	InvalidUserData.Base64FormatInvalid	The specified UserData is not valid	Valeur UserData non valide.
403	InvalidChargeType.ValueNotSupported	Deletion protection is only valid for postPaid instance, not for prePaid or spot instance.	La fonctionnalité de protection contre la suppression peut être utilisée uniquement sur les ressources en paiement à l'utilisation.
403	InvalidUser.Unauthorized	The user is not authorized	Vous n'êtes pas autorisé à effectuer cette opération.
403	EnterpriseGroupLimited.MutliGroupType	The specified instance can not join multi SecurityGroup types.	L'instance spécifiée ne peut pas appartenir à la fois à un groupe de sécurité basique et à un groupe de sécurité avancé. Vous pouvez appeler l'opération DescribeSecurityGroups pour interroger le type d'un groupe de sécurité spécifique.
403	SecurityGroupInstanceLimitExceed	%s	Le nombre maximal d'instances dans le groupe de sécurité spécifié est dépassé.
403	InstanceNotInSecurityGroup	The instance not in the group.	L'instance spécifiée n'appartient pas au groupe de sécurité.
403	InvalidOperation.InvalidRegion	%s	Valeur RegionId non valide.
403	OperationDenied	The specified Image is disabled or is deleted.	L'image spécifiée est désactivée ou supprimée.
403	InvalidOperation.ResourceManagedByCloudProduct	%s	Vous ne pouvez pas modifier les groupes de sécurité gérés par les services cloud.
403	InvalidParameter.InvalidEniQueueNumber	%s	Valeur QueueNumber non valide. Pour plus d'informations, consultez la valeur renvoyée par l'espace réservé %s dans le message d'erreur.
403	InvalidOperation.MaxEniQueueNumberExceeded	%s	Le nombre maximal de files d'attente par ENI est dépassé. Pour plus d'informations, consultez la valeur renvoyée par l'espace réservé %s dans le message d'erreur.
403	InvalidOperation.ExceedInstanceTypeQueueNumber	%s	Le nombre maximal de files d'attente pour toutes les ENI d'une instance est dépassé. Pour plus d'informations, consultez la valeur renvoyée par l'espace réservé %s dans le message d'erreur.
404	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	Le groupe de sécurité spécifié est introuvable dans ce compte. Vérifiez si l'ID du groupe de sécurité est correct.
404	Credit.NotFound	The specified credit information does not exist.	Les informations de crédit spécifiées n'existent pas.
404	InvalidParameter.SecurityGroupIdRepeated	The specified security group ids has repeated.	Des ID de groupe de sécurité en double ont été trouvés. Vérifiez si la valeur SecurityGroupIds.N est valide.
404	InvalidSecurityGroupType.NotSupportClassic	The specified SecurityGroupIds have classic group type.	Le groupe de sécurité spécifié se trouve dans le réseau classique. Vérifiez si la valeur SecurityGroupId.N est valide.
404	InvalidSecurityGroupVpc.NotBelongToOneVpc	The specified SecurityGroupIds are belong to different vpc.	Les groupes de sécurité spécifiés appartiennent à différents VPC. Vérifiez si la valeur SecurityGroupIds.N est valide. Vous pouvez appeler l'opération DescribeSecurityGroups pour interroger les VPC auxquels appartiennent les groupes de sécurité.
500	InternalError	The request processing has failed due to some unknown error.	Une erreur interne s'est produite. Réessayez ultérieurement.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Une erreur interne s'est produite. Réessayez ultérieurement.

Pour obtenir la liste des codes d'erreur, consultez la rubrique Codes d'erreur de service.