StopInstances_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

该接口为异步接口,实例的停止不是立即完成的,成功调用后,实例会先进入停止中(Stoping)状态,你可以调用 DescribeInstanceStatus 查看实例状态,当返回的状态为Stopped 时代表停止成功。

使用须知

流控信息

请求速率为1000/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:StopInstances
Update
Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

字段名称字段详情
DryRunboolean

是否发送预检请求。取值范围:展开详情

示例值:false
RegionIdstring

实例所在的地域。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ForceStopboolean

是否强制关机。取值范围:展开详情

示例值:false
StoppedModestring

停止模式。取值:展开详情

示例值:KeepCharging
BatchOptimizationstring

设置批量操作模式。取值范围:展开详情

示例值:AllTogether
InstanceIdarray<string>

实例 ID 数组。数组长度:1~100。

示例值:i-bp67acfmxazb4p****子级条数 <= 100

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:1C488B66-B819-4D14-8711-C4EAAA13AC01
InstanceResponsesobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
400
DRYRUN.SUCCESS
This request is a dryrun request with successful result.诊断
400
InvalidParameter.Encrypted.KmsNotEnable
Failed to perform this operation because KMS is not activated.诊断
403
InvalidInstanceId.NotFound
InstanceId should not be null.诊断
403
InvalidParameter.TooManyInstanceIds
Instance ids cannot be more than 100.诊断
403
Abs.InvalidInstanceIds.MalFormed
The specified instanceIds is not valid.诊断
403
InstanceLockedForSecurity
%s诊断
403
InstanceExpiredOrInArrears
%s诊断
403
IncorrectInstanceStatus
%s诊断
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 not found, %s.诊断
403
InvalidOperation.KMSServiceNotOpen
KMS service is currently not open.诊断
403
OperationDenied.SystemInstanceNotSupport
The system instance does not support the %s operation because %s.诊断
404
InvalidInstanceId.NotFound
%s诊断
404
InvalidInstanceIds.NotFound
The specified InstanceIds does not exist.诊断
409
InvalidOperation.Conflict
Request was denied due to conflict with a previous request, please try again later.诊断
500
InternalError
The request processing has failed due to some unknown error.诊断

变更历史

变更时间变更内容概要操作
2025-03-20
变更错误码403
2024-12-20
变更错误码400
变更错误码403

相关示例

创建实例(RunInstances)
2022-03-01
磁盘相关
2022-03-21