Queries change orders.
Debugging
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/ListChangeOrders HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
AppId | String | Query | Yes | 145341c-9708-4967-b3ec-24933767**** | The ID of the application. |
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. |
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. |
CoType | String | Query | No | CoCreateApp | The type of the change order. Valid values:
|
CoStatus | String | Query | No | 2 | The status of the change order. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 65E1F-43BA-4D0C-8E61-E4D1337F**** | The ID of the request. |
Message | String | success | The returned message. |
TraceId | String | 0bb6f815638568884597879d**** | The ID of the trace. It is used to query the details of a request. |
Data | Object | The information about change orders. |
|
CurrentPage | Integer | 1 | The number of the returned page. |
TotalSize | Integer | 1 | 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:
|
FinishTime | String | 2019-07-11 20:12:58 | The time when the change order was completed. |
CreateTime | String | 2019-07-11 15:54:49 | The time when the change order was created. |
UserId | String | sae-beta-test | The ID of the user. |
Source | String | console | The source of the change order. |
BatchCount | Integer | 1 | The number of release batches. |
CreateUserId | String | sae-beta-test | The ID of the user who created the change order. |
CoTypeCode | String | CoCreateApp | The code of the change type. Valid values:
|
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:
|
GroupId | String | c9ecd2-cf6c-46c3-9f20-525de202**** | The ID of the group. |
Description | String | Version: 1.0 | Image name: nginx | The description about the application. |
CoType | String | Create the application. | The change type, which corresponds to the CoTypeCode parameter. |
AppId | String | 164341c-9708-4967-b3ec-24933767**** | The ID of the application. |
PageSize | Integer | 20 | The number of entries returned on each page. |
ErrorCode | String | This parameter is left empty. | The error code.
|
Code | String | 200 | The HTTP status code. Valid values:
|
Success | Boolean | true | Indicates whether the list of change orders was obtained. Valid values:
|
Examples
Sample requests
GET /pop/v1/sam/changeorder/ListChangeOrders?AppId=145341c-9708-4967-b3ec-24933767****&CurrentPage=1&PageSize=20&Key=test&CoType=CoCreateApp&CoStatus=2 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
<ListChangeOrdersResponse>
<RequestId>65E1F-43BA-4D0C-8E61-E4D1337F****</RequestId>
<Message>success</Message>
<TraceId>0bb6f815638568884597879d****</TraceId>
<Data>
<CurrentPage>1</CurrentPage>
<TotalSize>1</TotalSize>
<ChangeOrderList>
<Status>2</Status>
<FinishTime>2019-07-11 20:12:58</FinishTime>
<CreateTime>2019-07-11 15:54:49</CreateTime>
<UserId>sae-beta-test</UserId>
<Source>console</Source>
<BatchCount>1</BatchCount>
<CreateUserId>sae-beta-test</CreateUserId>
<CoTypeCode>CoCreateApp</CoTypeCode>
<ChangeOrderId>7fa5c0-9ebb-4bb4-b383-1f885447****</ChangeOrderId>
<BatchType>auto</BatchType>
<GroupId>c9ecd2-cf6c-46c3-9f20-525de202****</GroupId>
<Description>Version: 1.0 | Image name: nginx</Description>
<Name>Create the application.</Name>
<AppId>164341c-9708-4967-b3ec-24933767****</AppId>
</ChangeOrderList>
<PageSize>20</PageSize>
</Data>
<Code>200</Code>
<Success>true</Success>
</ListChangeOrdersResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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 the application",
"AppId" : "164341c-9708-4967-b3ec-24933767****"
} ],
"PageSize" : 20
},
"Code" : "200",
"Success" : true
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
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. |
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. |
404 | InvalidAppId.NotFound | The specified AppId does not exist. | The error message returned when the specified application ID cannot be found. |
For a list of error codes, visit the API Error Center.