调用StopAppEnv停止一个部署环境。

  • 只能针对状态处于运行中的环境执行停止操作。
  • 此API被调用后将返回此次创建的变更ID，可以使用此ID查询变更信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /pop/v1/wam/appEnv/stop HTTP/1.1

请求参数

名称 类型 是否必选 示例值 描述
EnvId String 是 we-5d39b8ba6786bd4b149*****

环境ID，将停止此环境

返回数据

名称 类型 示例值 描述
Code String OK

响应代码，若成功请求为OK
EnvChange

环境变更信息
ChangeId String wc-5d247bbcd43be51c729*****

变更ID
EnvId String we-5d39b8ba6786bd4b149*****

环境ID
StartTime String 1562672060867

变更开始时间
Message String success

响应消息，若成功请求为success
RequestId String 8D69F3C4-EA43-49D5-875A-0893BF5*****

请求ID

示例

请求示例


http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/appEnv/stop??Id=we-5d22b3816f48e5478fd*****&<公共请求参数>

正常返回示例

XML 格式 

<StopAppEnvResponse>
    <EnvChange>
        <ChangeId>wc-5d247ab5d43be51c72*****</ChangeId>
        <EnvId>we-5d247866d43be51c729*****</EnvId>
        <StartTime>1562671797841</StartTime>
    </EnvChange>
    <Message>success</Message>
    <RequestId>05BB8B43-DAA6-4E19-9A3C-AF11DD1*****</RequestId>
    <Code>OK</Code>
</StopAppEnvResponse>

JSON 格式 

{
	"Message":"success",
	"RequestId":"633D9443-025A-4B39-8957-495CC2B*****",
	"EnvChange":{
		"EnvId":"we-5d247866d43be51c729*****",
		"ChangeId":"wc-5d247bbcd43be51c729*****",
		"StartTime":1562672060867
	},
	"Code":"OK"
}

错误码

HttpCode 错误码 错误信息 描述
403 ResourceAuthFailed The specified resource does not exist or it does not belong to this Alibaba Cloud account. 相关资源不存在或不属于此阿里云账号。
403 StatusNotAllowedStop A stop action can only be made to an environment that is already running. An environment with other status cannot be stopped. 应用停止只能针对已经在运行中的环境状态进行，其他状态不允许应用停止。
400 EnvOnChanging An error occurred while starting the change. Wait until the ongoing change is complete. 变更启动失败，原因是上一个变更正在进行，请等待上一次变更完成后再继续。

访问错误中心查看更多错误码。