调用 StopInstances 接口停止一台或多台实例。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StopInstances | 要执行的操作,取值:StopInstances。 |
Version | String | 是 | 2020-04-01 | API的版本,取值:2020-04-01。 |
ClientToken | String | 否 | 333456899ff**** | 保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。 |
ForceStop | Boolean | 否 | false | 是否强制关机,取值:
说明 以下类型的实例,
|
StoppedMode | String | 否 | KeepCharging | 停机模式。取值:
|
InstanceIds.N | Array of String | 是 | InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t****** | 实例ID,最多支持100个。
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
OperationDetails | Array of OperationDetailsForStopInstances | -- | 操作详情。 |
GET /?Action=StopInstances&Version=2020-04-01&InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t****** HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: ecs
{ "ResponseMetadata": { "RequestId": "2021062415303301022514515207C4****", "Action": "StopInstances", "Version": "2020-04-01", "Service": "ecs", "Region": "cn-beijing" }, "Result": { "OperationDetails": [ { "InstanceId": "i-ybo349sxoncm9t******", "Error": { "Code": "InvalidInstanceStatus", "Message": "The status of the specified instance does not support this request." } }, { "InstanceId": "i-ybo349sxolcm9t******", "Error": { "Code": "InvalidInstance.NotFound", "Message": "The specified instance does not exist." } } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidStoppedModeForScheduledInstance.Unsupported | The specified scheduled instance does not support stop charging. | 指定的弹性预约实例不支持节省停机模式。 |
400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | 幂等参数不一致。 |
400 | InvalidArgument | The specified argument is invalid. | 指定的参数不合法。 |
400 | InvalidClientToken.Malformed | The specified ClientToken is malformed. | 指定的ClientToken不合法。 |
400 | InvalidCount.Malformed | The specified count is malformed. | 指定的参数Count不合法。 |
400 | InvalidDedicatedHostStatus.Unsupported | The status of the specified dedicated host does not support this request. | 当前专有宿主机的状态不支持此操作。 |
400 | InvalidStoppedMode.Malformed | The specified StoppedMode is malformed. | 指定的StoppedMode不合法。 |
412 | IdempotentProcessing | The request uses the same client token as a previous one that is still in process. | 先前的幂等请求仍在处理中,请稍后重试。 |
500 | InternalError | An internal error has occurred. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |