ListChangeOrders-阿里云帮助中心

Lists change orders.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:ListChangeOrders

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	145341c-9708-4967-b3ec-24933767****
CurrentPage	integer	No	The current page number.	1
PageSize	integer	No	The number of entries to return on each page.	20
Key	string	No	The keyword for a fuzzy search of change order descriptions. The operation returns only the change orders whose descriptions contain the keyword.	test
CoType	string	No	The type of the change order. Valid values: CoBindSlb: Attach an SLB instance. CoUnbindSlb: Detach an SLB instance. CoCreateApp: Create an application. CoDeleteApp: Delete an application. CoDeploy: Deploy an application. CoRestartApplication: Restart an application. CoRollback: Roll back an application. CoScaleIn: Scale in an application. CoScaleOut: Scale out an application. CoStartApplication: Start an application. CoStopApplication: Stop an application. CoRescaleApplicationVertically: Change the instance type. CoDeployHistroy: Roll back to a previous version. CoBindNas: Attach a NAS file system. CoUnbindNas: Detach a NAS file system. CoBatchStartApplication: Batch start applications. CoBatchStopApplication: Batch stop applications. CoRestartInstances: Restart instances. CoDeleteInstances: Delete instances. CoScaleInAppWithInstances: Scale in an application by specifying instances.	CoCreateApp
CoStatus	string	No	The status of the change order. Valid values: 0: Preparing. 1: In progress. 2: Succeeded. 3: Failed. 6: Stopped. 8: Paused for manual confirmation. 9: Paused for automatic confirmation. 10: Failed due to a system exception. 11: Pending approval. 12: Approved and pending execution.	2
OrderBy	string	No	The field by which to sort the results.
Reverse	boolean	No	The sort order for the field specified by the OrderBy parameter. Valid values: true: The results are sorted in ascending order. false: The results are sorted in descending order.

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	65E1F-43BA-4D0C-8E61-E4D1337F****
Message	string	Additional information about the response.	success
TraceId	string	The trace ID used to query request details.	0bb6f815638568884597879d****
Data	object	The information about the change orders.
CurrentPage	integer	The current page number.	1
TotalSize	integer	The total number of change orders.	1
ChangeOrderList	array<object>	The list of change orders.
	object	Details of a change order.
Status	integer	The status of the change order. Valid values: 0: Preparing. 1: In progress. 2: Succeeded. 3: Failed. 6: Aborted. 8: Paused for manual confirmation. 9: Paused for automatic confirmation. 10: Failed due to a system exception. 11: Pending approval. 12: Approved and pending execution.	2
FinishTime	string	The time the change order was completed.	2019-07-11 20:12:58
CreateTime	string	The time the change order was created.	2019-07-11 15:54:49
UserId	string	The user ID.	sae-beta-test
Source	string	The source of the change order.	console
BatchCount	integer	The number of batches.	1
CreateUserId	string	The ID of the user who created the change order.	sae-beta-test
CoTypeCode	string	The code of the change type. Valid values: CoBindSlb: Bind an SLB instance. CoUnbindSlb: Unbind an SLB instance. CoCreateApp: Create an application. CoDeleteApp: Delete an application. CoDeploy: Deploy an application. CoRestartApplication: Restart an application. CoRollback: Roll back an application. CoScaleIn: Scale in an application. CoScaleOut: Scale out an application. CoStartApplication: Start an application. CoStopApplication: Stop an application. CoRescaleApplicationVertically: Change the instance type. CoDeployHistroy: Roll back to a previous version. CoBindNas: Bind a NAS file system. CoUnbindNas: Unbind a NAS file system. CoBatchStartApplication: Start multiple applications. CoBatchStopApplication: Stop multiple applications. CoRestartInstances: Restart instances. CoDeleteInstances: Delete instances. CoScaleInAppWithInstances: Scale in an application by specifying instances.	CoCreateApp
ChangeOrderId	string	The change order ID.	7fa5c0-9ebb-4bb4-b383-1f885447****
BatchType	string	The batch type. Valid values: auto: Automatic. manual: Manual.	auto
GroupId	string	The group ID.	c9ecd2-cf6c-46c3-9f20-525de202****
Description	string	The description.	Version: 1.0 \| Image name: nginx
CoType	string	The description of the change type code (CoTypeCode).	Create Application
AppId	string	The application ID.	164341c-9708-4967-b3ec-24933767****
PageSize	integer	The page size.	20
ErrorCode	string	The error code. This parameter is not returned on successful requests. Returned if the request fails. For more information, see the error code list in this topic.
Code	string	The HTTP status code or the POP error code. Valid values: 2xx: Success. 3xx: Redirect. 4xx: Request error. 5xx: Server error.	200
Success	boolean	Indicates whether the list of change orders was retrieved. Valid values: true: The list was retrieved. false: The list could not be retrieved.	true

Examples

Success response

JSON format

{
  "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": "Version: 1.0 | Image name: nginx",
        "CoType": "Create Application",
        "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.