ListChangeOrders - - Alibaba Cloud Documentation Center

Queries a list of change orders.

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:ListChangeOrders	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	1	145341c-9708-4967-b3ec-24933767****
CurrentPage	integer	No	20	1
PageSize	integer	No	test	20
Key	string	No	CoCreateApp	test
CoType	string	No	2	CoCreateApp
CoStatus	string	No	The ID of the request.	2

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The returned message.	65E1F-43BA-4D0C-8E61-E4D1337F****
Message	string	The ID of the trace. It is used to query the details of a request.	success
TraceId	string	The information about change orders.	0bb6f815638568884597879d****
Data	object	The number of the returned page.
CurrentPage	integer	The total number of change orders.	1
TotalSize	integer	The list of change orders.	1
ChangeOrderList	array<object>	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 batch. 10: The change order could not be executed due to a system exception. 11: The change order is pending approval. 12: The change order is approved and is pending execution.
ChangeOrder	object
Status	integer	The time when the change order was completed.	2
FinishTime	string	The time when the change order was created.	2019-07-11 20:12:58
CreateTime	string	The ID of the user.	2019-07-11 15:54:49
UserId	string	The source of the change order.	sae-beta-test
Source	string	The number of release batches.	console
BatchCount	integer	The ID of the user who created the change order.	1
CreateUserId	string	The code of the change type. Valid values: CoBindSlb: associates an 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 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 the specified application instances.	sae-beta-test
CoTypeCode	string	The ID of the change order.	CoCreateApp
ChangeOrderId	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.	7fa5c0-9ebb-4bb4-b383-1f885447****
BatchType	string	The ID of the group.	auto
GroupId	string	The description about the application.	c9ecd2-cf6c-46c3-9f20-525de202****
Description	string	The change type, which corresponds to the CoTypeCode parameter.
CoType	string	The ID of the application.
AppId	string	The number of entries returned on each page.	164341c-9708-4967-b3ec-24933767****
PageSize	integer	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.	20
ErrorCode	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.
Code	string	Indicates whether the list of change orders was obtained. Valid values: true: indicates that the list was obtained. false: indicates that the list could not be obtained.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "65E1F-43BA-4D0C-8E61-E4D1337F****",
  "Message": "success",
  "TraceId": "0bb6f815638568884597879d****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 1,
    "ChangeOrderList": [
      {
        "Status": 2,
        "FinishTime": "2019-07-11 20:12:58",
        "CreateTime": "2019-07-11 15:54:49",
        "UserId": "sae-beta-test",
        "Source": "console",
        "BatchCount": 1,
        "CreateUserId": "sae-beta-test",
        "CoTypeCode": "CoCreateApp",
        "ChangeOrderId": "7fa5c0-9ebb-4bb4-b383-1f885447****",
        "BatchType": "auto",
        "GroupId": "c9ecd2-cf6c-46c3-9f20-525de202****",
        "Description": "",
        "CoType": "",
        "AppId": "164341c-9708-4967-b3ec-24933767****"
      }
    ],
    "PageSize": 20
  },
  "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.
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