DescribeChangeOrder - - Alibaba Cloud Documentation Center

Queries the information of a change order.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeChangeOrder	get	All Resources *	none	none

Request syntax

GET /pop/v1/sam/changeorder/DescribeChangeOrder HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ChangeOrderId	string	Yes	76fa5c0-9ebb-4bb4-b383-1f885447****	76fa5c0-9ebb-4bb4-b383-1f885447****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message.	success
TraceId	string	The ID of the trace. It is used to query the details of a request.	0a98a02315955564772843261e****
Data	object	The details of the change order.
Status	integer	The status of the change order. Valid values: 0: The change order is being prepared. 1: The change order is being executed. 2: The change order was executed. 3: The change order could not be executed. 6: The change order was terminated. 8: The execution process is pending. You must manually determine the release batch. 9: The execution process is pending. SAE will automatically determine the release batches. 10: The execution failed due to a system exception. 11: The change order is pending approval. 12: The change order is approved and is pending execution.	2
SubStatus	integer	The substatus of the change order. This parameter indicates whether an exception occurred while the change order was being executed. Valid values: 0: No exception occurred. 1: An exception occurred. For example, when an error occurred during a phased release, you must manually roll back the application. In this case, the change order cannot be completed, so the Status parameter is still displayed as "1", which indicates that the change order is being executed. You can check the value of this parameter to determine whether an exception occurs.	0
ApprovalId	string	The approval ID of the change order.	67de0b39-a9d4-4c09-a170-cf438208****
ErrorMessage	string	The error message.	success
BatchWaitTime	integer	The interval between batches when SAE automatically determines the release batches in a phased release. Unit: minutes.	0
CreateTime	string	The time when the change order was created.	2020-12-17 21:06:45
BatchCount	integer	The number of release batches.	1
CoTypeCode	string	The code of the change type. Valid values: CoBindSlb: associates the Server Load Balancer (SLB) instance with the application. CoUnbindSlb: disassociates the SLB instance from the application. CoCreateApp: creates the application. CoDeleteApp: deletes the application. CoDeploy: deploys the application. CoRestartApplication: restarts the application. CoRollback: rolls back the application. CoScaleIn: scales in the application. CoScaleOut: scales out the application. CoStart: starts the application. CoStop: stops the application. CoRescaleApplicationVertically: modifies the instance specifications. CoDeployHistroy: rolls back the application to a historical version. CoBindNas: associates a network-attached storage (NAS) file system with the application. CoUnbindNas: disassociates the NAS file system from the application. CoBatchStartApplication: starts multiple applications concurrently. CoBatchStopApplication: stops multiple applications concurrently. CoRestartInstances: restarts the instances. CoDeleteInstances: deletes the instances. CoScaleInAppWithInstances: reduces the number of specified application instances.	CoRestartInstances
SupportRollback	boolean	Indicates whether the application can be rolled back. Valid values: true: The application can be rolled back. false: The application cannot be rolled back.	false
ChangeOrderId	string	The ID of the change order.	765fa5c0-9ebb-4bb4-b383-1f885447**
AppName	string	The name of the application.	app-test
BatchType	string	The mode in which the release batches are determined. Valid values: auto: SAE automatically determines the release batches. Manual: You must manually determine the release batches.	auto
Description	string	The description of the change order.	description
CoType	string	The description about the change type, which corresponds to the CoTypeCode parameter.
Auto	boolean	Indicates whether SAE automatically determines the release batches. Valid values: true: SAE automatically determines the release batches. false: SAE does not automatically determine the release batches.	true
CurrentPipelineId	string	The ID of the current batch.	0e4acf82-c9b1-4c1e-ac28-55776338****
Pipelines	array<object>	The batch information.
Pipeline	object
Status	integer	The status of the batch. Valid values: 0: The batch is being prepared. 1: The batch is being processed. 2: The batch was processed. 3: The batch could not be processed. 6: The batch processing was terminated. 8: The execution process is pending. You must manually determine the release batch. 9: The execution process is pending. SAE will automatically determine the release batch. 10: The batch could not be processed due to a system exception. 11: The change order is pending approval. 12: The change order is approved and is pending execution.	2
StartTime	long	The time when the batch processing starts.	1562831689704
UpdateTime	long	The time when the batch information is last modified.	1562847178007
BatchType	integer	The batch type.	0
ParallelCount	integer	The number of parallel tasks in a batch.	0
PipelineName	string	The name of the batch.	Batch 1 Change
PipelineId	string	The ID of the batch.	0e4acf82-c9b1-4c1e-ac28-55776338****
AppId	string	The ID of the application.	bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
ErrorCode	string	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.	200
Success	boolean	Indicates whether the information of a change order was obtained. Valid values: true: The information was obtained. false: The information could not be obtained.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	-
400	Resouce.no.permission	You are not authorized to operate on the specified resources.	You are not authorized to operate on the specified resources.
400	InvalidChangeOrder.NotFound	The current change order does not exist.	The current change order does not exist.
404	InvalidAppId.NotFound	The specified AppId does not exist.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history