本文介紹如何使用EDAS提供的Java SDK調用API在EDAS ECS集群中單批發布應用。
前提條件
在EDAS ECS環境中單批發布應用前,您必須提前完成以下準備工作:
- 安裝EDAS的Java SDK。更多信息,請參見Java SDK接入指南。
確定創建應用的地域,假設為cn-hangzhou。
創建微服務空間。具體操作,請參見創建命名空間。
如果已經存在命名空間,您可以調用ListUserDefineRegion接口查詢用戶自定義命名空間列表,獲取目標命名空間的RegionId。
在ECS集群中創建應用,具體操作,請參見使用API創建應用(ECS)。
如果已經創建應用,您可以調用ListApplication接口查詢應用列表,獲取目標應用的APPId,假設為6bbc57a2-a017-4bec-b521-49a15bd3****。
已將應用部署包(JAR包或WAR包)上傳至目標地址。本示例以OSS存儲路徑為例,假設為https:doc***.oss-cn-hangzhou.aliyuncs.com/sc-****-D-0.0.1-SNAPSHOT.jar。
如果需要發布HSF應用,則需要調用ListBuildPack接口查詢容器版本列表,獲取容器版本(ConfigId)參數,假設為57。
單批發布應用
以下代碼適用于在ECS環境單批發布應用。代碼中未設置環境變量等高級參數,如您需了解更多API參數信息,請參見DeployApplication。
以下代碼適用于單批發布Spring Cloud和Dubbo應用,如需發布HSF應用,則需要在代碼中增加EDAS-Container信息:
//EDAS-Container構建包號,當發布HSF應用時,該參數必須指定。可以調用ListBuildPack接口獲取,對應ConfigId參數。
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) {
// 阿里云賬號AccessKey擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維,請登錄RAM控制臺創建RAM用戶。
// 此處以把AccessKey和AccessKeySecret保存在環境變量為例說明。您可以根據業務需要,保存到配置文件里。
// 強烈建議不要把AccessKey和AccessKeySecret保存到代碼里,會存在密鑰泄漏風險。
String aliyun_user_ak = System.getenv("ACCESS_KEY_ID");
String aliyun_user_sk = System.getenv("ACCESS_KEY_SECRET");
//需要部署應用的所在地域ID。
String region_id = "cn-hangzhou";
DefaultProfile defaultProfile = DefaultProfile.getProfile(region_id, aliyun_user_ak, aliyun_user_sk);
DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
//創建API請求,并設置參數。
DeployApplicationRequest request = new DeployApplicationRequest();
//目標應用的AppId。
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
//應用描述信息。
request.setDesc("create by edas pop api");
//部署類型,僅支持設置為url。
request.setDeployType("url");
//應用部署包(WAR或JAR)的URL地址,建議使用OSS存儲的應用部署包路徑。
request.setWarUrl("https:doc***.oss-cn-hangzhou.aliyuncs.com/sc-****-D-0.0.1-SNAPSHOT.jar");
//部署的應用部署包版本,最長64個字符,建議使用時間戳。
request.setPackageVersion("1619094147");
//部署分組ID。如果要部署到所有分組,參數設置為all。
//如果需要部署到具體應用實例分組,可以調用ListDeployGroup接口獲取GroupId。
request.setGroupId("all");
//每組發布批次,設置為1,代表單批發布。
request.setBatch(1);
//分批方式,0表示自動,1表示批次間需要手動確認。
request.setReleaseType((long) 0);
//應用組件ID。您單批發布Spring Cloud或Dubbo時,JAR包部署需要選擇JDK版本,WAR包部署需要選擇Apache Tomcat版本;單批發布HSF應用時無需設置該參數。
//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();
}
}
}
運行程序,返回的執行結果如下所示:
Message=success
ChangeOrderId=f32db5e3-a105-412c-9168-6f7c5295****
結果驗證
您在ECS環境中部署應用后,可以調用GetChangeOrderInfo接口查看應用變更流程詳情,獲取部署應用的變更狀態。具體API參數詳情,請參見GetChangeOrderInfo。
調用GetChangeOrderInfo接口查看應用變更流程詳情,返回的執行結果如下:
{
"Message": "success",
"RequestId": "9C487FE4-F188-45EC-87A5-8BD3D655568F",
"Code": 200,
"changeOrderInfo": {
"Status": 2,
"Desc": "create by edas pop api",
"PipelineInfoList": {
......
//此處未羅列全部執行結果,僅供參考。
請查看上述執行結果中的changeOrderInfo.Status參數值,通過該值判斷單批發布應用的變更是否成功。changeOrderInfo.Status的取值如下:
0:準備
1:執行中
2:執行成功
3:執行失敗
6:終止
8:手動分批發布模式下,等待手工確認執行下一批
9:自動分批發布模式下,等待下一批執行中
10:系統異常執行失敗