ListNamespaceChangeOrders - Serverless App Engine - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

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

Request parameters


Parameter	Type	Position	Required	Example	Description
NamespaceId	String	Query	Yes	cn-shanghai:test	The ID of the namespace.
CoStatus	String	Query	No	2	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.
CoType	String	Query	No	CoBatchStartApplication	The type of the change order. Valid values: CoBatchStartApplication: starts multiple applications concurrently. CoBatchStopApplication: stops multiple applications concurrently.
Key	String	Query	No	test	Specifies a key used to query change orders by using fuzzy match. All change orders whose description contains the specified key will be returned.
CurrentPage	Integer	Query	No	1	The number of the page to return.
PageSize	Integer	Query	No	20	The number of entries to return on each page.

Response parameters


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

Examples

Sample requests

GET /pop/v1/sam/changeorder/listNamespaceChangeOrders?NamespaceId=cn-shanghai:test&CoStatus=2&CoType=CoBatchStartApplication&Key=test&CurrentPage=20&PageSize=1 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0bc3915638507554994370d****",
  "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" : "auto",
      "Description" : "Start multiple applications concurrently.",
      "GroupId" : "c9ecd2-cf6c-46c3-9f20-525de202****",
      "CoType" : "msg.docker.app.actions.CoBatchStartApplication",
      "Pipelines" : "xxxx"
    } ]
  }
}

Error codes


HttpCode	Error code	Error message	Description
400	Resouce.no.permission	You are not authorized to operate on the specified resources.	The error message returned because you do not have the required permissions on the resources.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	The error message returned because the value of the %s parameter is invalid. This parameter cannot be left empty.

For a list of error codes, visit the API Error Center.