ListNamespaceChangeOrders-阿里云帮助中心

Lists deployment orders in a namespace.

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:ListNamespaceChangeOrders

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	Yes	The namespace ID.	cn-shanghai:test
CoStatus	string	No	The change order status. Valid values: 0: Preparing. 1: Executing. 2: Succeeded. 3: Failed. 6: Terminated. 10: System Error.	2
CoType	string	No	The change order type. Valid values: CoBatchStartApplication: Batch Start Application. CoBatchStopApplication: Batch Stop Application.	CoBatchStartApplication
Key	string	No	A keyword for a fuzzy search of change order descriptions. Change orders whose descriptions contain this key are returned.	test
CurrentPage	integer	No	The current page.	1
PageSize	integer	No	The page size.	20

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	0bc3915638507554994370d****
ErrorCode	string	The error code. This parameter is returned only when a request fails. For more information, see the Error codes section of this topic.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The HTTP status code or POP error code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Message	string	The response message.	success
TraceId	string	The trace ID, which is used to query the details of the request.	0bc3915638507554994370d****
Data	object	The returned results.
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
TotalSize	integer	The total number of change orders.	32
ChangeOrderList	array<object>	The list of change orders.
	object	A change order.
Status	integer	The status of the change order. Valid values: 0: Preparing 1: In progress 2: Succeeded 3: Failed 6: Terminated 10: Failed due to a system exception	2
FinishTime	string	The completion time of the change order.	2019-07-11 20:12:58
NamespaceId	string	The namespace ID.	cn-shanghai:test
CreateTime	string	The creation time of the change order.	2019-07-11 15:54:49
UserId	string	The user ID.	test_sae
Source	string	The initiation source for the change order.	console
CreateUserId	string	The ID of the user who created the change order.	test@aliyun.com
BatchCount	integer	The batch count.	1
CoTypeCode	string	The type code of the change order. Valid values: CoBatchStartApplication: Starts applications in batches. CoBatchStopApplication: Stops applications in batches.	CoBatchStartApplication
ChangeOrderId	string	The change order ID.	7fa5c0-9ebb-4bb4-b383-1f885447****
BatchType	string	The batch type.
Description	string	The description of the change order.	Batch Start Applications
GroupId	string	The group ID.	c9ecd2-cf6c-46c3-9f20-525de202****
CoType	string	The type of the change order, which corresponds to the `CoTypeCode`.	msg.docker.app.actions.CoBatchStartApplication
Pipelines	string	The pipeline.	xxxx

Examples

Success response

JSON format

{
  "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": "Batch Start Applications",
        "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.