开发者社区 问答 正文

如何创建应用管理类 API


使用 Open API 创建一个应用。

请求URI

  1. /app/create_app


参数列表

参数名参数类型描述
AppNamestring应用名
BuildPackIdstring容器版本(参见 build_pack_list 获取容器列表)
RegionIdstring应用所在的区域
EcuListstring应用的部署机器列表
HealthCheckUrlstring应用健康检查 URL
Descstring应用描述


响应数据

  1. {
  2.     "code":200,
  3.     "data":{
  4.             "owner":"xxxxxxxx",
  5.             "desiredState":"RUNNING",
  6.             "buildpackId":11,
  7.             "instances":1,
  8.             "runnings":0,
  9.             "description":"样例应用",
  10.             "userId":"xxxxxxxx@aliyun.com",
  11.             "launchTime":1466647411805,
  12.             "prevState":"RUNNING",
  13.             "hcUrl":"http://localhost:8080/appname/check.html",
  14.             "createTime":1466578207327,
  15.             "phone":"150xxxxxxxx",
  16.             "regionId":"cn-beijing",
  17.             "appId":"08208d49-f8c8-454a-99b6-98d4c63d262e",
  18.             "name":"SampleApp",
  19.             "id":"08208d49-f8c8-454a-99b6-98d4c63d262e",
  20.             "state":"RUNNING",
  21.             "targetBuildpackId":0,
  22.             "email":"xxxxxx@aliyun.com"
  23.         }
  24.     }


示例

  1. Map<String,String> params = new HashMap<String,String>();
  2. params.put("AppName", "SampleApp");
  3. params.put("BuildPackId", "11");
  4. params.put("RegionId", "cn-beijing");
  5. params.put("EcuList", "f38bcf51-dd97-455d-b641-45250f094707,f38bcf51-dd97-455d-b641-45250f094707");
  6. params.put("HealthCheckUrl", "http://localhost:8080/appname/check.html");
  7. params.put("Desc", "样例应用");
  8. String resp = edasApiClient.callApi(EdasApiAction.App.create_app.path(), params);
  9. System.out.println(resp);

展开
收起
猫饭先生 2017-10-26 11:03:05 1300 分享 版权
阿里云 AI 助理回答

为了使用Open API创建一个应用,您可以遵循以下步骤和指导:

1. 功能描述

此API用于在阿里云平台上通过Open API接口创建新的应用程序。它支持指定应用名称、容器版本、部署区域、机器列表、健康检查URL及应用描述等关键参数,适用于自动化部署和管理应用的场景。

2. 前提条件

  • 确保您已获取到必要的访问权限,包括个人访问令牌(如x-yunxiao-token)或RAM用户的授权信息。
  • 知道您的组织ID,以及目标应用将要部署的区域ID。
  • 若是特定于ECS环境的应用创建,还需安装EDAS Java SDK并完成相关环境配置。
  • 对于某些应用类型,可能需要先查询容器版本列表以获取BuildPackId。

3. 请求参数

  • AppName (string): 应用名称,例如 "SampleApp"。
  • BuildPackId (string): 容器版本ID,需从build_pack_list接口获取。
  • RegionId (string): 应用部署的区域ID,如 "cn-beijing"。
  • EcuList (string): 部署机器列表,格式为逗号分隔的实例ID。
  • HealthCheckUrl (string): 应用健康检查的URL,例如 "http://localhost:8080/appname/check.html"。
  • Desc (string): 应用描述,例如 "样例应用"。

4. 请求示例

Map<String, String> params = new HashMap<>();
params.put("AppName", "SampleApp");
params.put("BuildPackId", "11");
params.put("RegionId", "cn-beijing");
params.put("EcuList", "f38bcf51-dd97-455d-b641-45250f094707,f38bcf51-dd97-455d-b641-45250f094707");
params.put("HealthCheckUrl", "http://localhost:8080/appname/check.html");
params.put("Desc", "样例应用");

// 调用API客户端进行请求
String resp = edasApiClient.callApi("/app/create_app", params);
System.out.println(resp);

5. 响应数据

响应数据通常包含应用的基本信息,例如:

{
    "code": 200,
    "data": {
        "owner": "xxxxxxxx",
        "desiredState": "RUNNING",
        "buildpackId": 11,
        "instances": 1,
        "runnings": 0,
        "description": "样例应用",
        "userId": "xxxxxxxx@aliyun.com",
        "launchTime": 1466647411805,
        "prevState": "RUNNING",
        "hcUrl": "http://localhost:8080/appname/check.html",
        "createTime": 1466578207327,
        "phone": "150xxxxxxxx",
        "regionId": "cn-beijing",
        "appId": "08208d49-f8c8-454a-99b6-98d4c63d262e",
        "name": "SampleApp",
        "id": "08208d49-f8c8-454a-99b6-98d4c63d262e",
        "state": "RUNNING",
        "targetBuildpackId": 0,
        "email": "xxxxxx@aliyun.com"
    }
}

其中包含了应用ID、状态、创建时间、描述等关键信息。

注意事项

  • 确保提供的所有参数符合API要求,特别是必填项。
  • 检查请求头中是否包含了正确的身份验证信息,如个人访问令牌。
  • 根据实际需求选择合适的请求参数,比如在不同场景下可能需要提供额外的参数,如模板名称、描述等。
  • 关注API调用返回的错误码,以便及时处理错误情况。

请根据具体应用场景调整上述示例代码中的参数值,并确保已正确设置API客户端的认证与请求环境。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答
问答分类:
问答地址: