調用DescribeChangeOrder API查詢變更單資訊-Serverless 應用引擎-阿里雲 - Serverless App Engine

調用DescribeChangeOrder介面查詢變更單資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:DescribeChangeOrder

get

*全部資源

*

無

請求文法

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

請求參數

名稱	類型	必填	描述	樣本值
ChangeOrderId	string	是	變更單 ID。通過調用 ListChangeOrders 介面擷取。	76fa5c0-9ebb-4bb4-b383-1f885447****

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
RequestId	string	請求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	調用結果的附加資訊。	success
TraceId	string	調用鏈 ID，用於精確查詢調用資訊。	0a98a02315955564772843261e****
Data	object	變更單資訊。
Status	integer	批次狀態。取值說明如下： 0：準備。 1：執行中。 2：執行成功。 3：執行失敗。 6：終止。 8：等待手工確認分批。 9：等待自動確認分批。 10：系統異常執行失敗。 11：等待審批。 12：審批通過，等待執行。	2
SubStatus	integer	發布單子狀態，用於判斷髮布單是否在發布過程中存在異常。取值說明如下： 0：發布正常。 1：發布異常。例如分批發布時出錯，需要您手動復原，此時發布單雖然出錯，但因不能完結而依然處於執行中。	0
ApprovalId	string	操作審批 ID。	67de0b39-a9d4-4c09-a170-cf438208****
ErrorMessage	string	錯誤資訊。	success
BatchWaitTime	integer	自動分批方式時，開始下一批次前的等待時間。單位：分鐘。	0
CreateTime	string	建立時間。	2020-12-17 21:06:45
BatchCount	integer	分批數。	1
CoTypeCode	string	變更類型 Code。取值說明如下： CoBindSlb：綁定 SLB。 CoUnbindSlb：解除綁定 SLB。 CoCreateApp：建立應用。 CoDeleteApp：刪除應用。 CoDeploy：部署應用。 CoRestartApplication：重啟應用。 CoRollback：復原應用。 CoScaleIn：應用縮容。 CoScaleOut：應用擴容。 CoStart：啟動應用。 CoStop：停止應用。 CoRescaleApplicationVertically：修改執行個體規格。 CoDeployHistroy：回退歷史版本。 CoBindNas：綁定 NAS。 CoUnbindNas：解除綁定 NAS。 CoBatchStartApplication：大量啟動應用。 CoBatchStopApplication：大量停止應用。 CoRestartInstances：重啟執行個體。 CoDeleteInstances：刪除執行個體。 CoScaleInAppWithInstances：指定執行個體縮容。	CoRestartInstances
SupportRollback	boolean	是否支援復原。取值說明如下： true：支援復原。 false：不支援復原。	false
ChangeOrderId	string	變更單 ID。	765fa5c0-9ebb-4bb4-b383-1f885447**
AppName	string	應用程式名稱。	app-test
BatchType	string	分批類型。取值說明如下： auto：自動。 manual：手動。	auto
Description	string	變更單描述資訊。	description
CoType	string	變更類型，是對 CoTypeCode 的描述。	Batch Restart Instances
Auto	boolean	是否為自動分批。取值說明如下： true：自動分批變更。 false：不是自動分批變更。	true
CurrentPipelineId	string	當前批次 ID。	0e4acf82-c9b1-4c1e-ac28-55776338****
Pipelines	array<object>	批次資訊。
	object	批次資訊。
Status	integer	批次狀態。取值說明如下： 0：準備。 1：執行中。 2：執行成功。 3：執行失敗。 6：終止。 8：等待手工確認分批。 9：等待自動確認分批。 10：系統異常執行失敗。 11：等待審批。 12：審批通過，等待執行。	2
StartTime	integer	開始時間。	1562831689704
UpdateTime	integer	最新動向時間。	1562847178007
BatchType	integer	分批類型。	0
ParallelCount	integer	分批內並行任務數。	0
PipelineName	string	批次名稱。	Batch 1 Change
PipelineId	string	批次 ID。	0e4acf82-c9b1-4c1e-ac28-55776338****
AppId	string	應用 ID。	bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
ApplicationUpdateStrategy	string	應用程式更新策略。
ApplicationEnableGreyTagRoute	boolean	是否啟用灰階標籤路由。
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	是否成功查詢變更單資訊。取值說明如下： true：查詢成功。 false：查詢失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "Batch Restart Instances",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****",
    "ApplicationUpdateStrategy": "",
    "ApplicationEnableGreyTagRoute": true
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的參數：%s不可為空。
400	Resouce.no.permission	You are not authorized to operate on the specified resources.	沒有許可權操作資源。
400	InvalidChangeOrder.NotFound	The current change order does not exist.	變更單不存在。
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。