Tenant Cloud Compute Cloud Virtual Machine Instance APIs StopInstances

StopInstances

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (StopInstances) is used to stop one or more instances.

  • Only instances in the RUNNING state can be stopped.
  • When the API is successfully called, the instance will enter the STOPPING state. When the instance is successfully stopped, it will enter the STOPPED state.
  • Forced stop is supported. The effect of forced stop is equivalent to turning off the switch of the physical computer. Forced stop may lead to data loss or damage of the file system. Use it only when the server cannot be normally stopped.
  • Batch operations are supported. A maximum of 100 batch instances per request are allowed.

Default interface request rate limit: 10 times per second.

Interface update time: 2025-07-31 04:07:53.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: StopInstances
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds Yes No Array of String One or more instance IDs to be operated. You can obtain the instance ID through the InstanceId in the returned value from the API DescribeInstances. A maximum of 100 batch instances per request are allowed.
Example: ["ins-r8hr2upy","ins-5d8a23rs"]
ForceStop No No Bool Whether to choose to perform forced shutdown on the instance after a normal shutdown fails. Value range:
  • TRUE: Indicates a forced shutdown after a normal shutdown fails
  • FALSE: Indicates no forced shutdown after a normal shutdown fails

    Default value: FALSE.
    Example: false
    		•
    StoppedMode No No String Shutdown mode of an instance. Value range: 
  • SOFT_FIRST: Indicates forced shutdown after normal shutdown fails
  • HARD: Directly perform forced shutdown
  • SOFT: Soft shutdown only
    Default value: SOFT.
    Example: KEEP_CHARGING
    		•
    StopType No No String Shutdown mode of an instance. Value range: SOFT_FIRST: Indicates forced shutdown after normal shutdown fails; HARD: Directly perform forced shutdown; SOFT: Soft shutdown only; Default value: SOFT.
    Example: SOFT
    DryRun No No Bool Internal parameter trial run.
    Example: false

    3. Output Parameters

    Parameter name Type Description
    TaskId String Task ID
    Example: 542324
    flowId Int64 Task Flow ID
    Example: 5
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidInstanceId.NotFound No corresponding instance was found.
    InvalidInstance.NotSupported Unsupported instance.
    InternalServerError Internal operation error.
    InvalidParameterValue.LimitExceeded The parameter value is out of range
    InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
    MissingParameter Parameters are missing. The request did not include mandatory parameters.
    InvalidInstanceId.Malformed Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error ins-1122.
    UnsupportedOperation.InstanceStateStopped The request does not support instances that are shut down.