You can call this operation to query the status of a deployment environment.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request headers

This operation uses common request headers, instead of special request headers. For more information, see the "Common request headers" section in "Common request and response headers."

Request syntax

GET /pop/v1/wam/appEnv/status HTTP/1.1

Request parameters

Parameter Type Required? Example Description
EnvId String Yes we-5d244085f314934e2ab15cd7

The ID of the deployment environment whose status is to be queried.

Response parameters

Parameter Type Example Description
Code String OK

The response code. The value is OK if the request is successful.

EnvStatus

The status of the deployment environment.

AbortingChange Boolean false

Indicates whether the deployment environment was terminated.

ApplyingChange Boolean false

Indicates whether the deployment environment is being changed.

ChangeBanner String Web+ is updating your deplpoyment environment.

The message notifying you of the change progress.

EnvId String we-5d1af9c902470221ab7d6db9"

The ID of the deployment environment.

EnvName String test1

The name of the deployment environment.

EnvStatus String RUNNING

The running status of the deployment environment.

InstanceAgentStatus

The statistics on the agent connections of ECS instances to the Web+ server.

ConnectedInstances Integer 0

The number of connected ECS instances.

DisconnectedInstances Integer 0

The number of disconnected ECS instances.

InstanceAppStatus

The statistics on the health status of ECS instances.

HealthyInstances Integer 0

The number of healthy ECS instances.

StoppedInstances Integer 0

The number of stopped ECS instances.

UnhealthyInstances Integer 0

The number of unhealthy ECS instances.

UnknownInstances Integer 0

The number of ECS instances whose status is unknown.

LastEnvStatus String INITIALIZING

The status of the deployment environment before the last change.

LatestChangeId String wc-5d3bb06a970b3f2e2a87c756"

The ID of the last change of the deployment environment.

Message String success

The response message. The value is success if the request is successful.

RequestId String 3CE38930-5A6A-4F7E-A6AD-DBF0EDE5CE6C

The ID of the request.

Examples

Sample request


http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/appEnv/status?ServiceCode=webx&Id=we-5d244085f314934e2ab15cd7&<Common request parameters>

Sample success response

XML format

<DescribeAppEnvStatusResponse>
    <EnvStatus>
        <EnvStatus>RUNNING</EnvStatus>
        <AbortingChange>false</AbortingChange>
        <ChangeBanner>Web+ is trying to recover your deployment environment</ChangeBanner>
        <LatestChangeId>wc-5d3bb06a970b3f2e2a87c756</LatestChangeId>
        <LastEnvStatus>INITIALIZING</LastEnvStatus>
        <EnvName>xianbin-test-env</EnvName>
        <EnvId>we-5d1af9c902470221ab7d6db9</EnvId>
        <ApplyingChange>false</ApplyingChange>
        <InstanceAgentStatus>
            <DisconnectedInstances>0</DisconnectedInstances>
            <ConnectedInstances>0</ConnectedInstances>
        </InstanceAgentStatus>
        <InstanceAppStatus>
            <UnhealthyInstances>0</UnhealthyInstances>
            <StoppedInstances>0</StoppedInstances>
            <HealthyInstances>0</HealthyInstances>
            <UnknownInstances>0</UnknownInstances>
        </InstanceAppStatus>
    </EnvStatus>
    <Message>success</Message>
    <RequestId>F1D5FD22-87AC-483A-9310-4F7C6FB6ECC5</RequestId>
    <Code>OK</Code>
</DescribeAppEnvStatusResponse>

JSON format

{
	"EnvStatus":{
		"EnvStatus":"RUNNING",
		"AbortingChange":false,
		"LastEnvStatus":"INITIALIZING",
		"ChangeBanner":"Web+ is trying to recover your deployment environment",
		"LatestChangeId":"wc-5d3bb06a970b3f2e2a87c756",
		"EnvName":"xianbin-test-env",
		"EnvId":"we-5d1af9c902470221ab7d6db9",
		"ApplyingChange":false,
		"InstanceAgentStatus":{
			"DisconnectedInstances":0,
			"ConnectedInstances":0
		},
		"InstanceAppStatus":{
			"UnhealthyInstances":0,
			"StoppedInstances":0,
			"HealthyInstances":0,
			"UnknownInstances":0
		}
	},
	"Message":"success",
	"RequestId":"30C31B90-F42F-4A17-9EE8-5CB5D690CB37",
	"Code":"OK"
}

Error codes

HTTP status code Error code Error message Description
403 ResourceAuthFailed The specified resource does not exist or it does not belong to this Alibaba Cloud account. The error message returned because the specified resource does not exist or it does not belong to your Alibaba Cloud account.

For more information about error codes, see API Error Center.