ListNamespaceChangeOrders - - Alibaba Cloud Documentation Center

Queries a list of change orders in a namespace.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	cn-shanghai:test	cn-shanghai:test
CoStatus	string	No	2	2
CoType	string	No	CoBatchStartApplication	CoBatchStartApplication
Key	string	No	test	test
CurrentPage	integer	No	1	1
PageSize	integer	No	20	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0bc3915638507554994370d****
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.
Success	boolean	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.	true
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
Message	string	The returned message.	success
TraceId	string	The ID of the trace. It is used to query the details of a request.	0bc3915638507554994370d****
Data	object	The returned data.
CurrentPage	integer	The number of the returned page.	1
PageSize	integer	The number of entries returned on each page.	20
TotalSize	integer	The total number of change orders.	32
ChangeOrderList	array<object>	The list of change orders.
ChangeOrder	object
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. 10: The change order could not be executed due to a system exception.	2
FinishTime	string	The time when the change order was completed.	2019-07-11 20:12:58
NamespaceId	string	The ID of the namespace.	cn-shanghai:test
CreateTime	string	The time when the change order was created.	2019-07-11 15:54:49
UserId	string	The ID of the user.	test_sae
Source	string	The source of the change order.	console
CreateUserId	string	The ID of the user who created the change order.	test@aliyun.com
BatchCount	integer	The number of release batches.	1
CoTypeCode	string	The code of the change order type. Valid values: CoBatchStartApplication: starts multiple applications concurrently. CoBatchStopApplication: stops multiple applications concurrently.	CoBatchStartApplication
ChangeOrderId	string	The ID of the change order.	7fa5c0-9ebb-4bb4-b383-1f885447****
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.
Description	string	The description of the change order.
GroupId	string	The ID of the group.	c9ecd2-cf6c-46c3-9f20-525de202****
CoType	string	The type of the change order, which corresponds the CoTypeCode parameter.	msg.docker.app.actions.CoBatchStartApplication
Pipelines	string	The information about release batches.	xxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bc3915638507554994370d****",
  "ErrorCode": "",
  "Success": true,
  "Code": "200",
  "Message": "success",
  "TraceId": "0bc3915638507554994370d****",
  "Data": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalSize": 32,
    "ChangeOrderList": [
      {
        "Status": 2,
        "FinishTime": "2019-07-11 20:12:58",
        "NamespaceId": "cn-shanghai:test",
        "CreateTime": "2019-07-11 15:54:49",
        "UserId": "test_sae",
        "Source": "console",
        "CreateUserId": "test@aliyun.com",
        "BatchCount": 1,
        "CoTypeCode": "CoBatchStartApplication",
        "ChangeOrderId": "7fa5c0-9ebb-4bb4-b383-1f885447****",
        "BatchType": "",
        "Description": "",
        "GroupId": "c9ecd2-cf6c-46c3-9f20-525de202****",
        "CoType": "msg.docker.app.actions.CoBatchStartApplication",
        "Pipelines": "xxxx"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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	InvalidParameter.NotEmpty	You must specify the parameter %s.	-

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

Change history

Change time	Summary of changes	Operation

No change history