ECS集群API概览
更新时间：2020-05-14 19:58:50
文本罗列了企业级分布式应用服务EDAS的ECS集群相关的API接口。
说明 ECS集群包含集群归属为阿里云和非阿里云的两种形态：
背景信息
ECS集群相关的API涉及的一些概念介绍如下：
- Region：指的是在各产品控制台顶部导航栏看到的华东1（杭州）、华东2（上海）、华北2（北京）等地域。
- 命名空间：指的是EDAS中设计的用于隔离集群、ECS实例和应用等资源及在EDAS中发布的微服务的一个逻辑概念，包括默认命名空间和自定义命名空间，每个地域下面包括一个默认命名空间和若干个自定义命名空间，默认情况下只有默认命名空间，如果不想隔离资源及微服务，则不必创建自定义命名空间。
- ECU：ECS导入到集群中后即为ECU。
- ECC：集群中的ECU在应用中部署后即成为ECC。
资源管理
| API | 描述 | 支持的集群形态 |
|---|---|---|
| ListAliyunRegion | 获取阿里云地域（Region）列表，每个地域下会有对应的默认命名空间。 | 阿里云ECS集群和非阿里云ECS集群 |
| ListEcuByRegion | 根据指定RegionId获取已导入EDAS的实例列表 | 阿里云ECS集群和非阿里云ECS集群 |
| MigrateEcu | 迁移已导入EDAS中的ECS实例到指定的命名空间内 | 阿里云ECS集群 |
| QueryMigrateRegionList | 查询可供迁移的命名空间列表 | 阿里云ECS集群和非阿里云ECS集群 |
| QueryMigrateEcuList | 查询可供迁移的已导入EDAS中的ECS实例列表 | 阿里云ECS集群 |
| QueryRegionConfig | 获取阿里云物理Region的配置信息 | 阿里云ECS集群和非阿里云ECS集群 |
| ListApplicationEcu | 获取ECU列表 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteEcu | 删除指定的ECU | 阿里云ECS集群和非阿里云ECS集群 |
| ListScaleOutEcu | 获取在创建应用或扩容前可用的ECS实例列表 | 阿里云ECS集群和非阿里云ECS集群 |
| SynchronizeResource | 同步阿里云基础资源到EDAS | 阿里云ECS集群 |
| InsertCluster | 创建集群 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteCluster | 删除集群 | 阿里云ECS集群和非阿里云ECS集群 |
| ListConvertableEcu | 获取导入到指定集群的ECS实例 | 阿里云ECS集群 |
| ListEcsNotInCluster | 获取所有未导入集群的ECS实例 | 阿里云ECS集群 |
| InsertClusterMember | 向集群中添加ECS实例 | 阿里云ECS集群 |
| ListClusterMembers | 根据集群ID获取实例列表 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteClusterMember | 删除集群实例 | 阿里云ECS集群和非阿里云ECS集群 |
| GetCluster | 获取集群详细信息 | 阿里云ECS集群和非阿里云ECS集群 |
| ListCluster | 获取集群列表 | 阿里云ECS集群和非阿里云ECS集群 |
| TransformClusterMember | 将ECS实例从一个集群中转移或者导入到另一个集群中去。
注意 没有导入到集群中的ECS实例无法转移集群。 |
阿里云ECS集群和非阿里云ECS集群 |
| InstallAgent | 安装EDAS Agent | 阿里云ECS集群 |
| ListResourceGroup | 获取资源组列表 | 阿里云ECS集群和非阿里云ECS集群 |
| ListSlb | 取得SLB列表 | 阿里云ECS集群和非阿里云ECS集群 |
| ListVpc | 取得VPC列表 | 阿里云ECS集群和非阿里云ECS集群 |
| GetPackageStorageCredential | 换取临时存储包所需的STS | 阿里云ECS集群和非阿里云ECS集群 |
应用管理
命名空间| API | 描述 | 支持的集群形态 |
|---|---|---|
| InsertOrUpdateRegion | 创建或编辑用户自定义命名空间 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteUserDefineRegion | 删除用户自定义命名空间 | 阿里云ECS集群和非阿里云ECS集群 |
| ListUserDefineRegion | 获取用户自定义命名空间列表 | 阿里云ECS集群和非阿里云ECS集群 |
| GetSecureToken | 获取给定命名空间的SecureToken信息 | 阿里云ECS集群和非阿里云ECS集群 |
| API | 描述 | 支持的集群形态 |
|---|---|---|
| InsertApplication | 创建应用 | 阿里云ECS集群和非阿里云ECS集群 |
| DeployApplication | 部署应用 | 阿里云ECS集群和非阿里云ECS集群 |
| GetApplication | 获取应用信息 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteApplication | 删除应用实例 | 阿里云ECS集群和非阿里云ECS集群 |
| ListApplication | 获取应用列表 | 阿里云ECS集群和非阿里云ECS集群 |
| ScaleOutApplication | 扩容应用实例 | 阿里云ECS集群和非阿里云ECS集群 |
| ScaleInApplication | 扩容或下线应用实例 | 阿里云ECS集群和非阿里云ECS集群 |
| ModifyScalingRule | 设置扩容规则 | 阿里云ECS集群和非阿里云ECS集群 |
| GetScalingRules | 获取扩缩容规则 | 阿里云ECS集群和非阿里云ECS集群 |
| StartApplication | 启动应用 | 阿里云ECS集群和非阿里云ECS集群 |
| StopApplication | 停止应用 | 阿里云ECS集群和非阿里云ECS集群 |
| ResetApplication | 重置应用 | 阿里云ECS集群和非阿里云ECS集群 |
| RestartApplication | 重启应用 | 阿里云ECS集群和非阿里云ECS集群 |
| RollbackApplication | 回滚应用 | 阿里云ECS集群和非阿里云ECS集群 |
| API | 描述 | 支持的集群形态 |
|---|---|---|
| QueryEccInfo | 查询ECC信息 | 阿里云ECS集群和非阿里云ECS集群 |
| QueryApplicationStatus | 查询应用状态 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateApplicationBaseInfo | 修改应用名称、描述信息和Owner信息。 | 阿里云ECS集群和非阿里云ECS集群 |
| ListHistoryDeployVersion | 应用发布历史版本列表 | 阿里云ECS集群和非阿里云ECS集群 |
| BindSlb | 绑定SLB | 阿里云ECS集群 |
| UnbindSlb | 解除绑定SLB | 阿里云ECS集群 |
| InsertDeployGroup | 创建部署分组 | 阿里云ECS集群和非阿里云ECS集群 |
| ChangeDeployGroup | 更换部署分组 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteDeployGroup | 删除部署分组 | 阿里云ECS集群和非阿里云ECS集群 |
| ListDeployGroup | 获取部署分组列表 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateContainer | 更新应用的运行时环境 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateHealthCheckUrl | 设置健康检查URL | 阿里云ECS集群和非阿里云ECS集群 |
| GetContainerConfiguration | 获取应用/分组下的Tomcat设置信息 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateContainerConfiguration | 设置应用或应用分组下的Tomcat信息 | 阿里云ECS集群和非阿里云ECS集群 |
| GetJvmConfiguration | 获取应用/分组内的JVM设置 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateJvmConfiguration | 设置应用下分组JVM | 阿里云ECS集群和非阿里云ECS集群 |
| ListBuildPack | 获取容器版本列表 | 阿里云ECS集群和非阿里云ECS集群 |
| ListComponents | 查询组件列表 | 阿里云ECS集群和非阿里云ECS集群 |
| GetChangeOrderInfo | 查看变更流程详情 | 阿里云ECS集群和非阿里云ECS集群 |
| ListRecentChangeOrder | 变更历史列表 | 阿里云ECS集群和非阿里云ECS集群 |
| AbortChangeOrder | 终止变更单 | 阿里云ECS集群和非阿里云ECS集群 |
| RollbackChangeOrder | 回滚变更单 | 阿里云ECS集群和非阿里云ECS集群 |
| ContinuePipeline | 手动确认执行下一批 | 阿里云ECS集群和非阿里云ECS集群 |
| QueryMonitorInfo | 查询监控信息 | 阿里云ECS集群和非阿里云ECS集群 |
系统管理
| API | 描述 | 支持的集群形态 |
|---|---|---|
| AuthorizeApplication | 授权应用 | 阿里云ECS集群和非阿里云ECS集群 |
| AuthorizeResourceGroup | 授权资源组 | 阿里云ECS集群和非阿里云ECS集群 |
| AuthorizeRole | 授权角色 | 阿里云ECS集群和非阿里云ECS集群 |
| DeleteRole | 删除角色 | 阿里云ECS集群和非阿里云ECS集群 |
| ListAuthority | 查询所有权限 | 阿里云ECS集群和非阿里云ECS集群 |
| ListRole | 获取角色列表 | 阿里云ECS集群和非阿里云ECS集群 |
| ListSubAccount | 获取子账号列 | 阿里云ECS集群和非阿里云ECS集群 |
| InsertRole | 创建角色 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateAccountInfo | 编辑账号信息 | 阿里云ECS集群和非阿里云ECS集群 |
| UpdateRole | 编辑角色 | 阿里云ECS集群和非阿里云ECS集群 |
服务管理
| API | 描述 | 支持的集群形态 |
|---|---|---|
| DeleteServiceGroup | 删除服务分组 | 阿里云ECS集群和非阿里云ECS集群 |
| InsertServiceGroup | 创建服务分组 | 阿里云ECS集群和非阿里云ECS集群 |
| ListConsumedServices | 查询消费的服务 | 阿里云ECS集群和非阿里云ECS集群 |
| ListPublishedServices | 查询发布的服务 | 阿里云ECS集群和非阿里云ECS集群 |
| ListPublishedServices | 查询服务分组列表 | 阿里云ECS集群和非阿里云ECS集群 |
| ListMethods | 查询服务方法列表 | 阿里云ECS集群和非阿里云ECS集群 |
