StopInstances - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Detiene una o más instancias de ECS. Puede especificar diferentes métodos de detención, modos de detención y modos de operación por lotes.

Descripción de la operación

Esta es una operación asíncrona. Las instancias no se detienen inmediatamente después de una llamada exitosa. Después de una llamada exitosa, la instancia entra en el estado Stopping. Puede llamar a DescribeInstanceStatus para consultar el estado de la instancia. Cuando el estado devuelto es Stopped, la instancia está detenida.

Antes de comenzar

Después de detener una instancia, esta deja de estar disponible. Asegúrese de que detener la instancia no afecte su negocio. Puede llamar a StartInstance o StartInstances para iniciar la instancia.
Las instancias bloqueadas por motivos de seguridad no se pueden detener mediante esta operación. Para obtener más información, consulte Impactos de los bloqueos de seguridad de recursos en las operaciones de API.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:StopInstances

update

*Instance.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DryRun	boolean	No	Especifica si se debe enviar una solicitud de ejecución de prueba. Valores válidos: true: envía una solicitud de ejecución de prueba sin detener las instancias. El sistema comprueba los parámetros requeridos, el formato de la solicitud y el estado de la instancia. Si la comprobación falla, se devuelve el error correspondiente. Si la comprobación es exitosa, se devuelve `DRYRUN.SUCCESS`. Nota Si el parámetro BatchOptimization se establece en `SuccessFirst`, el resultado de la ejecución de prueba para `DryRun=true` solo devuelve `DRYRUN.SUCCESS`. false: envía una solicitud normal. Después de que la solicitud pasa la comprobación, las instancias se detienen. Valor predeterminado: false.	false
RegionId	string	Sí	El ID de la región de las instancias. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
ForceStop	boolean	No	Especifica si se deben detener las instancias de forma forzada. Valores válidos: true: detiene las instancias de forma forzada. Aviso Una detención forzada equivale a un apagado. Los datos del sistema operativo que no se hayan escrito en los discos pueden perderse. Proceda con precaución. false: detiene las instancias de forma normal. Valor predeterminado: false.	false
StoppedMode	string	No	El modo de detención. Valores válidos: StopCharging: modo económico. Después de habilitar el modo económico: Se suspende la facturación de los recursos de computación (vCPU, memoria y GPU), las tarifas de licencia de imágenes y el ancho de banda fijo de las direcciones IP públicas estáticas. Continúa la facturación de los discos del sistema, los discos de datos y el ancho de banda fijo de las direcciones IP elásticas (EIP). Dado que los recursos de computación se liberan, es posible que la instancia no se inicie debido a recursos insuficientes. Inténtelo de nuevo más tarde o cambie el tipo de instancia. Si se asocia una EIP con la instancia antes de detenerla, la dirección IP permanece sin cambios después de reiniciar la instancia. De lo contrario, la dirección IP pública estática puede cambiar, pero la dirección IP privada permanece sin cambios. Para obtener más información, consulte Modo económico. Importante Si la instancia no admite el modo económico, la API no devuelve un error. El sistema prioriza la detención de la instancia. Los tipos de instancia que no admiten el modo económico incluyen instancias con SSD locales e instancias de suscripción. KeepCharging: modo de detención estándar. Después de detener la instancia, los recursos de la instancia se conservan y la facturación continúa. El inventario de tipos de instancia de ECS y la dirección IP pública también se conservan. Si detiene la instancia para reemplazar el sistema operativo, reinicializar un disco, cambiar el tipo de instancia o modificar la dirección IP privada, seleccione este modo para evitar fallas de inicio. Valor predeterminado: Si habilita el modo económico para instancias conectadas a VPC y se cumplen las condiciones, el valor predeterminado es `StopCharging`. De lo contrario, el valor predeterminado es `KeepCharging`.	KeepCharging
BatchOptimization	string	No	El modo de operación por lotes. Valores válidos: AllTogether: Todas las operaciones deben ser exitosas para que toda la operación por lotes se considere exitosa. Si alguna operación falla, toda la operación por lotes se considera fallida y todas las operaciones ejecutadas se revierten al estado previo a la operación. SuccessFirst: Cada operación en el lote se ejecuta de forma independiente. Si una operación falla, otras operaciones aún se pueden ejecutar y confirmar como exitosas. En este modo, las operaciones exitosas se confirman y las operaciones fallidas se marcan como fallidas sin afectar los resultados de otras operaciones. Valor predeterminado: AllTogether.	AllTogether
InstanceId	array	Sí	La matriz de ID de instancia. Longitud de la matriz: de 1 a 100.	i-bp67acfmxazb4p****
	string	No	El ID de la instancia.	i-bp67acfmxazb4p****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
InstanceResponses	object
InstanceResponse	array<object>	La matriz de objetos InstanceResponse que contiene el estado antes y después de la operación y el resultado de la operación para cada instancia.
	object
Code	string	El código de error del resultado de la operación de la instancia. Un valor devuelto de 200 indica éxito. Para obtener más información, consulte la sección de códigos de error.	200
CurrentStatus	string	El estado actual de la instancia.	Stopping
InstanceId	string	El ID de la instancia.	i-bp67acfmxazb4p****
Message	string	El mensaje de error devuelto para la operación de la instancia. Un valor devuelto de `success` indica que la operación fue exitosa. Para obtener más información, consulte la sección de códigos de error.	success
PreviousStatus	string	El estado de la instancia antes de la operación.	Running
RequestId	string	El ID de la solicitud.	1C488B66-B819-4D14-8711-C4EAAA13AC01

Ejemplos

Respuesta exitosa

JSON Formato

{
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "CurrentStatus": "Stopping",
        "InstanceId": "i-bp67acfmxazb4p****",
        "Message": "success",
        "PreviousStatus": "Running"
      }
    ]
  },
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be added ECS tag
400	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service account have no right to access your KMS.	ECS no tiene permiso para acceder a su Key Management Service (KMS).
400	DRYRUN.SUCCESS	This request is a dryrun request with successful result.	La solicitud de ejecución de prueba (dry run) se ha comprobado y aprobado.
400	InvalidParameter.Encrypted.KmsNotEnable	The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidInstanceId.NotFound	InstanceId should not be null.
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	La longitud de la lista InstanceIds supera los 100 elementos.
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.	El parámetro InstanceId especificado no es válido.
403	InstanceLockedForSecurity	%s
403	InstanceExpiredOrInArrears	%s
403	IncorrectInstanceStatus	%s	El estado actual de la instancia no admite esta operación.
403	InvalidInstanceId.NotSupport	%s
403	InsufficientBalance	Your account does not have enough balance.
403	InstanceNotReady	The specified instance is not ready for use.
403	InvalidOperation.KMSKeyIdNotFound	The specified KMSKeyId does not exist. Please verify that the key ID is correct and that the key resides in the current region.
403	InvalidOperation.KMSServiceNotOpen	KMS service is currently not open.	Key Management Service (KMS) no se ha activado.
403	OperationDenied.SystemInstanceNotSupport	The system instance does not support the %s operation because %s.
403	OperationDenied.KMSKeyUnauthorized	The operation is denied due to missing KMS key authorization. Please check the KMS key permissions and ensure the key is properly authorized for this operation.
404	InvalidInstanceId.NotFound	%s
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.	El InstanceId especificado no existe. Compruebe si el valor del parámetro InstanceId es correcto. Puede llamar a DescribeInstances para consultar el estado de la instancia especificada.
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.	El servicio no está disponible actualmente. Inténtelo de nuevo más tarde.
409	InvalidOperation.Conflict	Request was denied due to conflict with a previous request, please try again later.	Esta operación no está permitida debido a un conflicto de tareas.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.