本文介绍如何使用EDAS提供的Java SDK调用API在EDAS ECS集群中单批发布应用。

前提条件

在EDAS ECS环境中单批发布应用前,您必须提前完成以下准备工作:
  • 安装EDAS的Java SDK。更多信息,请参见Java SDK接入指南
  • 确定创建应用的地域,假设为cn-hangzhou
  • 创建微服务空间,假设为cn-hangzhou:doc。具体操作,请参见创建命名空间

    如果已经存在微服务空间,您可以调用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)  {
        //阿里云账号或RAM用户的AccessKey ID。
        String aliyun_user_ak = "<yourAccessKeyId>";
        //阿里云账号或RAM用户的AccessKey Secret。
        String aliyun_user_sk = "<yourAccessKeySecret>";
        //需要部署应用的所在地域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:系统异常执行失败