UpgradeApplication - ENS - Alibaba Cloud Documentation Center

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	a2bac6f4-75dc-455e-8389-2dc8e47526d3
Template	string	Yes	The information template for phased update. The value must be a JSON string and contain the following information: Version range that you want to update Configuration information of the target version Canary release policy for resources Intelligent upgrade policy that contains information such as the time window and resource usage limit	{\"fromAppVersions\":{ \"operator\":\"In\", \"values\":[ \"v1\", \"v2\" ] }, \"toAppVersion\":\"v3\", \"descrip\":\"xxx\", \"workload\":[ { \"name\":\"nginx\", \"podSpec\":{ } } ], \"upgradeStrategy\":{ \"name\":\"ScheduleToISP\", \"parameters\":{ \"operator\":\"In\", \"values\":[ \"telecom\" ] } }, \"autoUpgradeStrategy\":{ \"name\":\"AdjustToPodUsage\", \"checkInterval\":600, \"startTime\":\"2021-02-19 00:00:00\", \"startHourPoint\":\"0\", \"endHourPoint\":\"8\", \"endTime\":\"2021-02-19 08:00:00\", \"level\":\"RegionId\", \"rules\":[ { \"regionCodes\":[ \"cn-wuxi-telecom_unicom_cmcc\", \"cn-shijiazhuang-telecom_unicom_cmcc\" ], \"usageRatioLimit\":{ \"maxPodUsageRatio\":50 }, \"maxUpgradingRatio\":50 }, { \"regionCodes\":[ \"cn-wuhan-telecom_unicom_cmcc\" ], \"usageRatioLimit\":{ \"maxPodUsageRatio\":30 }, \"maxUpgradingRatio\":20 }, { \"regionCodes\":[ \"All\" ], \"usageRatioLimit\":{ \"maxPodUsageRatio\":20 }, \"maxUpgradingRatio\":50, \"maxUpgradingCount\":2 } ] }}
Timeout	integer	No	The timeout period for asynchronous upgrade. Unit: seconds. Default value: 300.	1800

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The task ID. You can use the task ID to query the upgrade progress or status.	6f24a774-6bd5-4026-bb7d-deffb1dad875

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "6f24a774-6bd5-4026-bb7d-deffb1dad875"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.	-
400	NoPermission	Permission denied.	-
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-
400	InvalidParameter	The errorMessage is %s. Please check it again.	-
400	ens.interface.error	An error occurred while calling the API.	-
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

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

Change history

Change time	Summary of changes	Operation
2024-05-11	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-21	API Description Update. The Error code has changed	View Change Details