StopInstances - - Centre de documentation Alibaba Cloud

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é et toutes les opérations y sont interdites.
Si le mode économique est activé pour les instances avec paiement à l'utilisation, définissezStoppedMode sur KeepCharging pour activer le mode standard. Une fois les instances arrêtées en mode standard, la facturation se poursuit et les ressources de type d'instance ainsi que les adresses IP publiques sont conservées.
Les opérations par lot sont prises en charge. Utilisez le paramètre BatchOptimization pour spécifier le mode d'opération par lot.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de 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	StopInstances	Opération à effectuer. Définissez la valeur sur StopInstances.
DryRun	Boolean	No	false	Indique s'il faut effectuer un test à blanc. Valeurs possibles : true : effectue un test à blanc. Le système vérifie les paramètres requis, la syntaxe de la requête et l'état de l'instance. Si la requête échoue au test à blanc, un message d'erreur est renvoyé. Si la requête réussit le test à blanc, `DRYRUN.SUCCESS` est renvoyé. Remarque Si vous définissez `BatchOptimization` sur `SuccessFirst` et `DryRun` sur true, seul `DRYRUN.SUCCESS` est renvoyé, que la requête réussisse ou non le test à blanc. false : effectue un test à blanc et envoie la requête. Si la requête réussit le test à blanc, l'opération est effectuée. Valeur par défaut : false.
RegionId	String	Yes	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
ForceStop	Boolean	No	false	Indique s'il faut arrêter l'instance de force. Valeurs possibles : true : arrête l'instance de force. Cette opération équivaut à une mise hors tension dans les scénarios courants. Les données en cache non écrites sur les périphériques de stockage de l'instance sont perdues. false : arrête l'instance normalement. Valeur par défaut : false.
StoppedMode	String	No	KeepCharging	Mode d'arrêt de l'instance avec paiement à l'utilisation. Valeurs possibles : StopCharging : mode économique. Pour plus d'informations sur les conditions d'application de `StopCharging`, consultez la section « Conditions d'activation du mode économique » dans Mode économique. KeepCharging : mode standard. La facturation se poursuit après l'arrêt de l'instance en mode standard. Valeur par défaut : si les conditions d'activation du mode économique sont remplies et que vous avez activé ce mode dans la console ECS, la valeur par défaut est StopCharging. Pour plus d'informations, consultez la section « Activer le mode économique » dans `Economical mode`. Sinon, la valeur par défaut est `KeepCharging`.
BatchOptimization	String	No	AllTogether	Mode d'opération par lot. Valeurs possibles : AllTogether : dans ce mode, un message de succès est renvoyé si toutes les instances spécifiées sont arrêtées. Si une ou plusieurs des instances spécifiées échouent à la vérification lorsque vous définissez le paramètre DryRun sur false, aucune des instances spécifiées n'est arrêtée et un message d'erreur est renvoyé. SuccessFirst : dans ce mode, chaque instance est arrêtée séparément. La réponse contient les résultats de l'opération pour chaque instance. Valeur par défaut : AllTogether.
InstanceId.N	String	Yes	i-bp67acfmxazb4p****	ID de l'instance N. Valeurs possibles pour N : 1 à 100.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	1C488B66-B819-4D14-8711-C4EAAA13AC01	ID de la requête.
InstanceResponses	Array of InstanceResponse		Détails des réponses spécifiques à chaque instance, contenant l'état de chaque instance avant et après l'appel de l'opération, ainsi que les résultats de l'opération.
InstanceResponse
Code	String	200	Code d'erreur renvoyé pour l'instance. La valeur de retour 200 indique un succès. Pour plus d'informations, consultez la section « Codes d'erreur » de cette rubrique.
Message	String	success	Message d'erreur renvoyé pour l'instance. La valeur de retour Success indique le succès de l'opération. Pour plus d'informations, consultez la section « Codes d'erreur » de cette rubrique.
InstanceId	String	i-bp67acfmxazb4p****	ID de l'instance.
CurrentStatus	String	Stopping	État actuel de l'instance.
PreviousStatus	String	Running	État de l'instance avant l'appel de l'opération.

Exemples

Exemple de requête

http(s)://ecs.aliyuncs.com/?Action=StopInstances
&InstanceId.1=i-bp67acfmxazb4p****
&InstanceId.2=i-bp67acfmxazb4p****
&RegionId=cn-hangzhou
&ForceStop=false
&StoppedMode=KeepCharging
$BatchOptimization=SuccessFirst
&Common request parameters

Exemple de réponse en cas de succès

Format XML

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

<StopInstancesResponse>
    <RequestId>FF53E96D-3F1A-42F0-8373-1C2B39D72D44</RequestId>
    <InstanceResponses>
        <InstanceResponse>
            <Message>success</Message>
            <InstanceId>i-bp67acfmxazb4p****</InstanceId>
            <PreviousStatus>Running</PreviousStatus>
            <CurrentStatus>Stopping</CurrentStatus>
            <Code>200</Code>
        </InstanceResponse>
        <InstanceResponse>
            <Message>success</Message>
            <InstanceId>i-bp67acfmxazb4p****</InstanceId>
            <PreviousStatus>Running</PreviousStatus>
            <CurrentStatus>Stopping</CurrentStatus>
            <Code>200</Code>
        </InstanceResponse>
        <InstanceResponse>
            <Message>The specified InstanceId does not exist.</Message>
            <InstanceId>i-TestID</InstanceId>
            <PreviousStatus/>
            <CurrentStatus/>
            <Code>InvalidInstanceId.NotFound</Code>
        </InstanceResponse>
    </InstanceResponses>
</StopInstancesResponse>

Format JSON

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

{
  "RequestId" : "FF53E96D-3F1A-42F0-8373-1C2B39D72D44",
  "InstanceResponses" : {
    "InstanceResponse" : [ {
      "Message" : "success",
      "InstanceId" : "i-bp67acfmxazb4p****",
      "PreviousStatus" : "Running",
      "CurrentStatus" : "Stopping",
      "Code" : "200"
    }, {
      "Message" : "success",
      "InstanceId" : "i-bp67acfmxazb4p****",
      "PreviousStatus" : "Running",
      "CurrentStatus" : "Stopping",
      "Code" : "200"
    }, {
      "Message" : "The specified InstanceId does not exist.",
      "InstanceId" : "i-TestID",
      "PreviousStatus" : "",
      "CurrentStatus" : "",
      "Code" : "InvalidInstanceId.NotFound"
    } ]
  }
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.	Le message d'erreur indique que la clé maître cliente (CMK) n'est pas activée lorsqu'un ID de clé KMS est spécifié pour un disque. Appelez l'opération DescribeKey de KMS pour obtenir les informations sur la CMK spécifiée.
400	DRYRUN.SUCCESS	This request is a dryrun request with successful result.	Le message d'erreur indique qu'un test à blanc a été effectué et que la requête a réussi ce test.
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.	Le message d'erreur indique que le paramètre InstanceId.N spécifié n'est pas valide.
403	IncorrectInstanceStatus	%s	Le message d'erreur indique que l'opération n'est pas prise en charge tant que l'instance se trouve dans son état actuel.
403	InsufficientBalance	Your account does not have enough balance.	Le message d'erreur indique que le solde de votre compte est insuffisant. Approvisionnez votre compte et réessayez.
403	InstanceNotReady	The specified instance is not ready for use.	Le message d'erreur indique que l'opération n'est pas prise en charge tant que la ressource se trouve dans son état actuel. Réessayez ultérieurement.
404	InvalidInstanceId.NotFound	%s	Le message d'erreur indique que l'instance spécifiée n'existe pas. Vérifiez la validité de l'ID d'instance spécifié.
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.	Le message d'erreur indique que l'ID d'instance spécifié n'existe pas. Vérifiez la validité de l'ID d'instance spécifié. Appelez l'opération DescribeInstances pour obtenir l'état d'instances spécifiques.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	Le message d'erreur indique que l'instance spécifiée n'existe pas. Vérifiez la validité de l'ID d'instance spécifié.
500	InternalError	The request processing has failed due to some unknown error.	Le message d'erreur indique qu'une erreur interne s'est produite. Réessayez ultérieurement.

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