使用API在ECS集群中分批發(fā)布應(yīng)用
本文介紹如何使用EDAS提供的Java SDK調(diào)用API在EDAS ECS集群中分批發(fā)布應(yīng)用。
前提條件
在EDAS ECS環(huán)境中分批發(fā)布應(yīng)用前，您必須提前完成以下準(zhǔn)備工作：
- 安裝EDAS的Java SDK。更多信息，請參見Java SDK接入指南。
確定創(chuàng)建應(yīng)用的地域，假設(shè)為cn-hangzhou。
創(chuàng)建微服務(wù)空間。具體操作，請參見創(chuàng)建命名空間。
如果已經(jīng)存在命名空間，您可以調(diào)用ListUserDefineRegion接口查詢用戶自定義命名空間列表，獲取目標(biāo)命名空間的RegionId。
在ECS集群中創(chuàng)建應(yīng)用，具體操作，請參見使用API創(chuàng)建應(yīng)用（ECS）。
如果已經(jīng)創(chuàng)建應(yīng)用，您可以調(diào)用ListApplication接口查詢應(yīng)用列表，獲取目標(biāo)應(yīng)用的AppId，假設(shè)為6bbc57a2-a017-4bec-b521-49a15bd3****。
已將應(yīng)用部署包（JAR包或WAR包）上傳至目標(biāo)地址。本示例以O(shè)SS存儲(chǔ)路徑為例，假設(shè)為https:doc***.oss-cn-hangzhou.aliyuncs.com/sc-****-D-0.0.1-SNAPSHOT.jar。
如果需要發(fā)布HSF應(yīng)用，則需要調(diào)用ListBuildPack接口查詢?nèi)萜靼姹玖斜恚@取容器版本（ConfigId）參數(shù)，假設(shè)為57。
分批發(fā)布應(yīng)用
以下代碼適用于在ECS環(huán)境分批發(fā)布應(yīng)用。代碼中未設(shè)置環(huán)境變量等高級參數(shù)，如您需了解更多API參數(shù)信息，請參見DeployApplication。
以下代碼適用于分批發(fā)布Spring Cloud和Dubbo應(yīng)用，如需發(fā)布HSF應(yīng)用，則需要在代碼中增加EDAS-Container信息：
//EDAS-Container構(gòu)建包號(hào)，當(dāng)發(fā)布HSF應(yīng)用時(shí)，該參數(shù)必須指定。可以調(diào)用ListBuildPack接口獲取，對應(yīng)ConfigId參數(shù)。
request.setBuildPackId(57);import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.edas.model.v20170801.DeployApplicationRequest;
import com.aliyuncs.edas.model.v20170801.DeployApplicationResponse;
public class DeployApplication {
public static void main(String[] args) {
// 阿里云賬號(hào)AccessKey擁有所有API的訪問權(quán)限，風(fēng)險(xiǎn)很高。強(qiáng)烈建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問或日常運(yùn)維，請登錄RAM控制臺(tái)創(chuàng)建RAM用戶。
// 此處以把AccessKey和AccessKeySecret保存在環(huán)境變量為例說明。您可以根據(jù)業(yè)務(wù)需要，保存到配置文件里。
// 強(qiáng)烈建議不要把AccessKey和AccessKeySecret保存到代碼里，會(huì)存在密鑰泄漏風(fēng)險(xiǎn)。
String aliyun_user_ak = System.getenv("ACCESS_KEY_ID");
String aliyun_user_sk = System.getenv("ACCESS_KEY_SECRET");
//需要部署應(yīng)用的所在地域ID。
String region_id = "cn-hangzhou";
DefaultProfile defaultProfile = DefaultProfile.getProfile(region_id, aliyun_user_ak, aliyun_user_sk);
DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
//創(chuàng)建API請求，并設(shè)置參數(shù)。
DeployApplicationRequest request = new DeployApplicationRequest();
//目標(biāo)應(yīng)用的AppId。
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
//應(yīng)用描述信息。
request.setDesc("分批發(fā)布應(yīng)用");
//部署類型，僅支持設(shè)置為url。
request.setDeployType("url");
//應(yīng)用部署包（WAR或JAR）的URL地址，建議使用OSS存儲(chǔ)的應(yīng)用部署包路徑。
request.setWarUrl("https:doc***.oss-cn-hangzhou.aliyuncs.com/sc-****-D-0.0.1-SNAPSHOT.jar");
//部署的應(yīng)用部署包版本，最長64個(gè)字符，建議使用時(shí)間戳。
request.setPackageVersion("1619094147");
//部署分組ID。如果要部署到所有分組，參數(shù)設(shè)置為all。
//如果需要部署到具體應(yīng)用實(shí)例分組，可以調(diào)用ListDeployGroup接口獲取GroupId。
request.setGroupId("all");
//每組發(fā)布批次，設(shè)置為大于1，代表分批發(fā)布。
request.setBatch(2);
//分批方式，0表示自動(dòng)，1表示批次間需要手動(dòng)確認(rèn)。建議使用自動(dòng)發(fā)布方式。
request.setReleaseType((long) 0);
//分批等待時(shí)間，單位分鐘。默認(rèn)為0，表示不等待；最大值為5。
request.setBatchWaitTime(1);
//應(yīng)用組件ID。您單批發(fā)布Spring Cloud或Dubbo時(shí)，JAR包部署需要選擇JDK版本，WAR包部署需要選擇Apache Tomcat版本；單批發(fā)布HSF應(yīng)用時(shí)無需設(shè)置該參數(shù)。
//4代表Apache Tomcat 7.0.91，7代表Apache Tomcat 8.5.42，5代表OpenJDK 1.8.x，6代表OpenJDK 1.7.x。
request.setComponentIds("5");
try {
DeployApplicationResponse response = client.getAcsResponse(request);
System.out.println("Message=" + response.getMessage() + "\nChangeOrderId=" + response.getChangeOrderId());
} catch (ServerException e) {
e.printStackTrace();
} catch (ClientException e) {
e.printStackTrace();
}
}
}運(yùn)行程序，返回的執(zhí)行結(jié)果如下所示：
Message=success
ChangeOrderId=04c5638f-405e-41de-99b2-e0dccb2****結(jié)果驗(yàn)證
您在分批發(fā)布應(yīng)用后，可以調(diào)用GetChangeOrderInfo接口查看變更流程詳情，獲取分批發(fā)布應(yīng)用的變更狀態(tài)。具體API參數(shù)詳情，請參見GetChangeOrderInfo。
調(diào)用GetChangeOrderInfo接口查看變更流程詳情，返回的執(zhí)行結(jié)果如下：
{
"Message": "success",
"RequestId": "01FAA54A-43C0-4681-B985-33BA44D64340",
"Code": 200,
"changeOrderInfo": {
"Status": 2,
"Desc": "分批發(fā)布",
"PipelineInfoList": {
"PipelineInfo": [
{
......
"PipelineId": "4ff02b63-e14d-4124-86ff-22239f80****"
......
"PipelineId": "6dbbfff8-bcf7-4300-aa59-ccb06909****"
......
//此處未羅列全部執(zhí)行結(jié)果，僅供參考。
}請查看上述執(zhí)行結(jié)果中的changeOrderInfo.Status參數(shù)值，通過該值判斷分批發(fā)布應(yīng)用的變更是否成功。changeOrderInfo.Status的取值如下：
0：準(zhǔn)備
1：執(zhí)行中
2：執(zhí)行成功
3：執(zhí)行失敗
6：終止
8：手動(dòng)分批發(fā)布模式下，等待手工確認(rèn)執(zhí)行下一批。
9：自動(dòng)分批發(fā)布模式下，等待下一批執(zhí)行中。
10：系統(tǒng)異常執(zhí)行失敗
手動(dòng)確認(rèn)下一批發(fā)布
如果您使用的是手動(dòng)確認(rèn)分批發(fā)布方式，則需要調(diào)用ContinuePipeline接口手動(dòng)確認(rèn)下一批發(fā)布。
調(diào)用GetChangeOrderInfo接口，獲取分批發(fā)布應(yīng)用變更的相關(guān)批次的流程ID（PipelineId）。
調(diào)用GetChangeOrderInfo接口，返回結(jié)果如下：
{ "Message": "success", "RequestId": "01FAA54A-43C0-4681-B985-33BA44D64340", "Code": 200, "changeOrderInfo": { "Status": 8, "Desc": "分批發(fā)布應(yīng)用", "PipelineInfoList": { "PipelineInfo": [ { ...... "PipelineId": "4ff02b63-e14d-4124-86ff-22239f80****" ...... "PipelineId": "6dbbfff8-bcf7-4300-aa59-ccb06909****" ...... //此處未羅列全部執(zhí)行結(jié)果，僅供參考。 }說明如果您設(shè)置的是應(yīng)用的ECS實(shí)例分2批發(fā)布+手動(dòng)的分批發(fā)布方式，在調(diào)用GetChangeOrderInfo接口返回結(jié)果中會(huì)出現(xiàn)2個(gè)流程ID（PipelineId），第二次出現(xiàn)的流程ID（PipelineId）代表需要手動(dòng)確認(rèn)發(fā)布的批次。
按此規(guī)律，如果是應(yīng)用的ECS實(shí)例分3批發(fā)布+手動(dòng)的分批發(fā)布方式，則會(huì)出現(xiàn)3個(gè)流程ID（PipelineId），第二次和第三次出現(xiàn)的流程ID（PipelineId）代表需要手動(dòng)確認(rèn)發(fā)布的批次。
調(diào)用ContinuePipeline接口，手動(dòng)確認(rèn)下一批發(fā)布。
返回結(jié)果如下：
{ "Message": "success", "RequestId": "B8ECF6F7-672D-40E9-91DD-1C33F06D4FD8", "Code": 200 }說明如果是需要手動(dòng)確認(rèn)多批的場景，請選擇正確批次的流程ID（PipelineId）并重復(fù)執(zhí)行此步驟。