最近更新时间:2023.07.25 18:39:31
首次发布时间:2022.07.01 09:15:17
调用 StopInstances 接口停止一台或多台实例。
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StopInstances | 要执行的操作,取值:StopInstances。 |
Version | String | 是 | 2020-04-01 | API的版本,取值:2020-04-01。 |
InstanceIds.N | String | 是 | InstanceIds.1=i-ybo349sxoncm9t******&InstanceIds.2=i-ybo349sxolcm9t****** | 实例ID,最多支持100个ID。
|
StoppedMode | String | 否 | KeepCharging | 停机模式,取值:
说明 该参数不传或传入空值时,实例默认为普通停机模式。 |
ForceStop | Boolean | 否 | false | 是否强制关机,取值:
说明 以下类型的实例,
|
ClientToken | String | 否 | 333456899ff**** | 保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。 取值:仅支持ASCII字符,且不能超过64个字符。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
OperationDetails | Array of Struct | - | 操作详情,具体请参见下表“ OperationDetails结构 ”。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | i-ybo349sxoncm9t****** | 操作的实例ID。 |
Error | Struct | - | 操作的实例错误信息,具体请参见下表“ Error结构 ”。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | InvalidInstance.NotFound | 批量操作时具体单个请求失败的错误码,具体请参见下表“ 错误码(批量操作时具体单个请求失败)”。 |
Message | String | The specified instance does not exist. | 批量操作时具体单个请求失败的错误信息,具体请参见下表“ 错误码(批量操作时具体单个请求失败)”中的错误信息。 |
错误码 | 错误信息 | 描述 |
---|---|---|
InvalidInstance.NotFound | The specified instance does not exist. | 指定的实例不存在。 |
MissingParameter.InstanceId | The required parameter InstanceId is not supplied. | 实例ID不能为空。 |
InvalidInstanceStatus | The status of the specified instance does not support this request. | 当前实例的状态不支持此操作。 |
InvalidStoppedMode.Conflict | The specified StoppedMode conflicts with instance status. | StoppedMode与实例状态冲突。 |
InvalidStoppedMode.ChargeTypeMismatch | The specified StopCharging mismatch instance's ChargeType. | 当前实例的计费类型不支持节省停机模式。 |
InvalidStoppedMode.InstanceTypeMismatch | The specified StopCharging mismatch instance's InstanceType. | 当前实例的机型不支持节省停机模式。 |
OperationDenied.ResourceLocked | The specified operation is denied as your resource is locked for another operation. | 指定的操作被拒绝,因为您的资源已被其他操作锁定。 |
OperationDenied.ResourceCreatedByOtherService | The specified operation is denied as your resource is created by other service. You can check system tags to find the service. | 指定的操作被拒绝,因为您的资源被其他服务创建。您可以通过资源的系统标签查询对应服务。 |
OperationDenied.InstanceIsCreatingImage | The specified operation is denied as your instance is creating image. | 指定的操作被拒绝,因为您的实例正在创建自定义镜像。 |
FlowLimitExceeded | You've reach the limit on request rate of resources. | 您已超过资源请求限速。 |
Insufficient.InstanceCapacity | There is not enough capacity to fulfill your request. | 当前资源不足,请稍后重试或选择其它实例规格。 |
InternalError | An internal error has occurred. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
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." } } ] } }
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidCount.Malformed | The specified count is malformed. | 指定的实例数目不合法。 |
400 | InvalidStoppedMode.Malformed | The specified StoppedMode is malformed. | 指定的StoppedMode 不合法。 |
400 | InvalidArgument | The specified argument is invalid. | 指定的参数不合法。 |
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 | InvalidClientToken.Malformed | The specified ClientToken is malformed. | 指定的ClientToken不合法。 |
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. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |