You can call this operation to query the change information about a change operation that collects diagnostic information.

Note This operation can only query the change information about diagnostic information collection.

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/gatherStats HTTP/1.1

Request parameters

Parameter Type Required? Example Description
ChangeId String No wc-5d4134b956fd7c14ac91*****

The change ID used to query the change information about diagnostic information collection.

Response parameters

Parameter Type Example Description
Code String OK

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

GatherStatsResult

The result of diagnostic information collection.

Change

The information about the change.

ActionName String GatherStats

The name of the change operation.

ChangeAborted Boolean false

Indicates whether the change was terminated.

ChangeDescription String gather stats of env we-5d3eaaea2977ca5251e***** on [\"{\\\"targetInstances\\\":\\\"i-wz94zz7mx8kt5kz*****\\\"}\"]

The description of the change.

ChangeFinished Boolean true

Indicates whether the change was completed.

ChangeId String wc-5d4134b956fd7c14ac9*****

The ID of the change.

ChangeMessage String ""

The message of the change.

ChangeName String gather.stats

The name of the change.

ChangePaused Boolean false

Indicates whether the change was stopped.

ChangeSucceeded Boolean true

Indicates whether the change was successful.

ChangeTimedout Boolean false

Indicates whether the change timed out.

CreateTime Long 1564554425575

The start time of the change.

CreateUsername String user1

The name of the user who created the change.

EnvId String we-5d3eaaea2977ca5251e*****

The ID of the deployment environment.

FinishTime Long 1564554426063

The time when the change was completed.

UpdateTime Long 1564554426111

The time when the change was last updated.

InstanceResults

The diagnostic information collection result of ECS instances.

InstanceId String ""

The ID of the ECS instance.

StorageKey String ""

The storage key of the diagnostic information collection result.

TaskMessage String ""

The message of the diagnostic information collection task.

TaskSucceeded Boolean true

Indicates whether the task was successful.

Message String success

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

RequestId String D208107C-B729-4C92-80EE-7257131*****

The ID of the request.

Examples

Sample request


http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/appEnv/gatherStats?ChangeId=wc-5d4134b956fd7c14ac9*****&<Common request parameters>

Sample success response

XML format

<DescribeGatherStatsResultResponse>
    <Message>success</Message>
    <RequestId>344B98E9-269C-47D6-B55A-1CB268A*****</RequestId>
    <GatherStatsResult>
        <InstanceResults> </InstanceResults>
        <Change>
            <ChangeName>gather.stats</ChangeName>
            <ActionName>GatherStats</ActionName>
            <ChangeAborted>false</ChangeAborted>
            <ChangeTimedout>false</ChangeTimedout>
            <UpdateTime>1564554426111</UpdateTime>
            <ChangeDescription>gather stats of env we-5d3eaaea2977ca5251e***** on ["{\"targetInstances\":\"i-wz94zz7mx8kt5kz*****\"}"]</ChangeDescription>
            <EnvId>we-5d3eaaea2977ca5251e*****</EnvId>
            <FinishTime>1564554426063</FinishTime>
            <CreateUsername>user1</CreateUsername>
            <ChangeSucceeded>true</ChangeSucceeded>
            <CreateTime>1564554425575</CreateTime>
            <ChangeId>wc-5d4134b956fd7c14ac9*****</ChangeId>
            <ChangeFinished>true</ChangeFinished>
            <ChangeMessage></ChangeMessage>
            <ChangePaused>false</ChangePaused>
        </Change>
    </GatherStatsResult>
    <Code>OK</Code>
</DescribeGatherStatsResultResponse>

JSON format

{
	"Message":"success",
	"GatherStatsResult":{
		"InstanceResults":{
			"InstanceResult":[]
		},
		"Change":{
			"ChangeName":"gather.stats",
			"ActionName":"GatherStats",
			"ChangeAborted":false,
			"ChangeTimedout":false,
			"UpdateTime":1564554426111,
			"ChangeDescription":"gather stats of env we-5d3eaaea2977ca5251e***** on [\"{\\\"targetInstances\\\":\\\"i-wz94zz7mx8kt5kz*****\\\"}\"]",
			"EnvId":"we-5d3eaaea2977ca5251e*****",
			"FinishTime":1564554426063,
			"CreateUsername":"user1",
			"ChangeSucceeded":true,
			"CreateTime":1564554425575,
			"ChangeId":"wc-5d4134b956fd7c14ac9*****",
			"ChangeFinished":true,
			"ChangeMessage":"",
			"ChangePaused":false
		}
	},
	"RequestId":"D208107C-B729-4C92-80EE-7257131*****",
	"Code":"OK"
}

Error codes

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