租户端 计算 云服务器（CVM） 实例相关接口 StopInstances

StopInstances

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： cvm.api3.gsesgpucloud.com。

本接口 (StopInstances) 用于关闭一个或多个实例。

  • 只有状态为RUNNING的实例才可以进行此操作。
  • 接口调用成功时，实例会进入STOPPING状态；关闭实例成功时，实例会进入STOPPED状态。
  • 支持强制关闭。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。
  • 支持批量操作。每次请求批量实例的上限为100。

默认接口请求频率限制：10次/秒。

接口更新时间：2022-10-27 11:47:05。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：StopInstances
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds 是 否 Array of String 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
示例值： ["ins-r8hr2upy","ins-5d8a23rs"]
ForceStop 否 否 Bool 是否在正常关闭失败后选择强制关闭实例。取值范围：
  • TRUE：表示在正常关闭失败后进行强制关闭
  • FALSE：表示在正常关闭失败后不进行强制关闭

    默认取值：FALSE。
    示例值： false
    		•
    StoppedMode 否 否 String 实例的关闭模式。取值范围：
  • SOFT_FIRST：表示在正常关闭失败后进行强制关闭
  • HARD：直接强制关闭
  • SOFT：仅软关机
    默认取值：SOFT。
    示例值： KEEP_CHARGING
    		•
    StopType 否 否 String 实例的关闭模式。取值范围：SOFT_FIRST：表示在正常关闭失败后进行强制关闭HARD：直接强制关闭SOFT：仅软关机默认取值：SOFT。
    示例值： SOFT

    3. 输出参数

    参数名称 类型 描述
    TaskId String 任务ID
    示例值： 542324
    FlowId Int64 任务流转ID
    示例值： 5
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

    错误码 描述
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidInstance.NotSupported 不被支持的实例。
    InternalServerError 操作内部错误。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。