API概览

本产品(企业级分布式应用服务/2017-08-01)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

系统管理

API标题API概述
InsertRole创建角色调用InsertRole创建角色。
DeleteRole来删除角色调用DeleteRole来删除角色。
UpdateRole编辑角色调用UpdateRole编辑角色。
AuthorizeRole授权角色授权角色。
UpdateAccountInfo编辑账号信息调用UpdateAccountInfo接口编辑账号信息。
ListRole获取角色列表调用ListRole接口获取角色列表。
ListSubAccount获取子账号列表调用ListSubAccount接口获取子账号和RAM用户列表。
ListAuthority查询所有权限调用ListAuthority接口查询所有权限。
GetPackageStorageCredential获取临时存储包所需的STS调用GetPackageStorageCredential接口获取临时存储包所需的STS。
AuthorizeApplication为子账号授权应用调用AuthorizeApplication接口为子账号或RAM用户授予应用的操作权限。
AuthorizeResourceGroup为子账号授予资源组的操作权限调用AuthorizeResourceGroup接口为子账号或RAM用户授予指定资源组的操作权限。

资源管理

API标题API概述
ECS集群和K8s集群ECS集群和K8s集群
DeleteUserDefineRegion删除指定的自定义命名空间调用DeleteUserDefineRegion接口删除指定的自定义命名空间。
DeleteCluster删除集群调用DeleteCluster接口用于删除ECS集群或取消导入K8s集群。
TagResources为资源绑定标签调用TagResources为指定的资源统一创建并绑定标签。
UntagResources删除资源标签调用UntagResources接口为指定的资源列表统一解绑标签。
ListAliyunRegion获取阿里云地域列表调用ListAliyunRegion接口获取阿里云地域列表。
QueryMigrateRegionList查询可供迁移的命名空间列表调用QueryMigrateRegionList接口查询可供迁移的命名空间列表。
ListCluster获取集群列表调用ListCluster接口获取集群列表。
GetCluster获取集群信息调用GetCluster接口获取指定集群的信息。
ListVpc获取 VPC 列表调用ListVpc接口获取VPC列表,该接口适用于ECS集群和K8s集群。
QueryRegionConfig获取不同地域的配置内容调用QueryRegionConfig接口获取不同地域的配置内容。
ListApplicationEcu获取ECU列表调用ListApplicationEcu接口获取ECU列表。
ListResourceGroup查询资源组信息调用ListResourceGroup接口获取资源组列表。
ListTagResources查询资源绑定的标签列表调用ListTagResources接口查询云资源已经绑定的标签列表。
ECS集群ECS集群
CreateIDCImportCommand生成非阿里云ECS集群的导入命令调用CreateIDCImportCommand接口生成非阿里云ECS集群的导入命令。
BindSlb绑定SLB到指定应用调用BindSlb接口绑定SLB到指定应用。
DeleteClusterMember删除集群实例调用DeleteClusterMember接口删除集群实例。
DeleteEcu删除指定的 ECU删除指定的 ECU。
ListClusterMembers获取ECS实例列表调用ListClusterMembers接口获取ECS实例列表。
ListEcuByRegion来获取指定命名空间下可用的ECU列表调用ListEcuByRegion来获取指定命名空间下可用的ECU列表。
ListConvertableEcu列出可导入到指定集群的ECS实例列表调用ListConvertableEcu接口列出可导入到指定集群的ECS实例列表。本API适用于ECS集群。
ListEcsNotInCluster获取所有未导入集群的 ECS调用ListEcsNotInCluster接口获取所有未导入集群的ECS实例。
QueryMigrateEcuList查询可迁移的实例列表调用QueryMigrateEcuList来查询可迁移的实例列表。
ListScaleOutEcu获取用于应用扩容的ECU列表调用ListScaleOutEcu接口从指定集群或应用关联集群获取可用于应用扩容的ECU列表。该接口仅适用于ECS集群。
ListSlb获取SLB列表调用ListSlb接口获取SLB列表。
InsertCluster创建集群调用InsertCluster接口创建集群。
InsertClusterMember向ECS集群中导入ECS实例调用InsertClusterMember接口向ECS集群中导入ECS实例。
InstallAgent安装 Agent使用ECS自带的云助手安装EDAS Agent(将ECS导入EDAS)。
TransformClusterMember导入或转移ECS实例调用TransformClusterMember接口导入或转移ECS实例。
MigrateEcu转移ECU到指定命名空间的默认集群调用MigrateEcu接口转移ECU到指定命名空间的默认集群。
SynchronizeResource同步阿里云基础资源到EDAS同步用户下的阿里云基础资源到EDAS。适用于ECS集群。
K8s集群K8s集群
UpdateK8sResource更新容器服务K8s资源调用UpdateK8sResource更新K8s资源。
GetK8sCluster获取K8s集群列表获取容器服务K8s集群或Serverless K8s集群列表。
ListK8sNamespaces获取K8s命名空间列表调用ListK8sNamespaces接口获取K8s命名空间列表。
ImportK8sCluster导入容器服务K8s集群调用ImportK8sCluster接口导入容器服务K8s集群或Serverless K8s集群。

应用管理

API标题API概述
ECS集群和K8s集群通用ECS集群和K8s集群通用
UpdateApplicationBaseInfo修改应用名称描述信息、Owner信息。
UpdateHealthCheckUrl设置健康检查 URL调用UpdateHealthCheckUrl来设置健康检查URL。
InsertOrUpdateRegion创建或编辑自定义命名空间调用InsertOrUpdateRegion接口创建或编辑自定义命名空间。
SwitchAdvancedMonitoring查询或启停高级监控调用SwitchAdvancedMonitoring接口查询ECS和K8s集群中应用高级监控开关状态及控制接口。
GetChangeOrderInfo查看变更流程详情调用GetChangeOrderInfo接口查看变更流程详情。
GetSecureToken获取命名空间SecureToken信息调用GetSecureToken获取指定命名空间的SecureToken信息,主要是用来获取指定命名空间的AccessKey ID、AccessKey Secret 、TenantId、地址服务器域名等信息。
QueryEccInfo查询ECC信息适用于容器服务K8s集群。
GetScalingRules获取扩缩容规则调用GetScalingRules接口获取扩缩容规则。
ListUserDefineRegion获取用户自定义命名空间列表调用ListUserDefineRegion接口获取用户自定义命名空间列表。
GetContainerConfiguration获取应用或分组的 Tomcat 设置调用GetContainerConfiguration接口获取应用或应用分组的Tomcat配置。
ListApplication获取应用列表调用ListApplication获取应用列表。
ListHistoryDeployVersion应用发布历史版本列表调用ListHistoryDeployVersion接口,获取应用部署的历史版本列表。
ListRecentChangeOrder列出应用历史变更单列表调用ListRecentChangeOrder列出应用历史变更单列表。
ListBuildPack获取容器版本列表调用ListBuildPack接口获取容器版本列表。
ContinuePipeline执行下一批发布调用ContinuePipeline接口手动确认执行下一批发布。
AbortChangeOrder终止变更流程调用AbortChangeOrder接口终止变更流程。
RollbackChangeOrder回滚变更单调用RollbackChangeOrder终止应用的变更流程,并回滚应用。该接口适用于ECS集群中的应用。
ECS集群专属ECS集群专属
AddLogPath添加日志目录适用于在阿里云和非阿里云ECS集群中部署的应用。
InsertDeployGroup创建应用部署分组调用InsertDeployGroup接口创建应用分组。
BindEcsSlb来给部署在ECS集群中的应用绑定SLB调用BindEcsSlb接口来给部署在ECS集群中的应用绑定SLB。
DeleteApplication删除应用实例适用于ECS集群中的应用。
DeleteLogPath删除日志目录适用于在阿里云和非阿里云ECS集群中部署的应用。
DeleteDeployGroup删除分组调用DeleteDeployGroup来删除分组。
UnbindSlb解除绑定SLB调用UnbindSlb接口解除绑定SLB。
UpdateHookConfiguration为应用或分组设置挂载脚本调用UpdateHookConfiguration来为应用或分组设置挂载脚本。
ModifyScalingRule设置扩缩容规则调用ModifyScalingRule接口修改弹性扩、缩容规则。
StartApplication启动应用调用StartApplication来启动应用。
StopApplication停止应用来停止应用。
UpdateContainer更新HSF应用的EDAS-Container版本调用UpdateContainer接口更新HSF应用的EDAS-Container版本。EDAS-Container包含Ali-Tomcat和Pandora。
UpdateContainerConfiguration设置应用下的分组设置调用UpdateContainerConfiguration接口设置ECS集群中应用或应用分组的Tomcat。
ChangeDeployGroup更换分组调用ChangeDeployGroup更换ECS集群应用中的ECS实例的分组。
UpdateJvmConfiguration来配置应用分组内的JVM设置调用UpdateJvmConfiguration来配置应用或应用分组的JVM。
RollbackApplication回滚应用调用RollbackApplication接口回滚应用。
GetJvmConfiguration获取应用或分组的 JVM 设置调用GetJvmConfiguration接口获取应用或应用分组的JVM设置。
GetApplication获取应用信息调用GetApplication接口获取ECS集群中指定应用的信息。 。
ListDeployGroup获取部署分组列表调用ListDeployGroup接口获取部署分组列表。
ListComponents查询组件列表调用ListComponents接口查询组件列表,本API适用于ECS集群中的应用。
QueryApplicationStatus查询应用状态调用QueryApplicationStatus接口查询应用状态。
InsertApplication创建 ECS 集群的应用调用InsertApplication接口在ECS集群中创建应用。
DeployApplication用于向 ECS 集群部署应用调用DeployApplication接口在ECS集群中部署应用。
ScaleoutApplicationWithNewInstances代购实例并扩容到指定分组调用ScaleoutApplicationWithNewInstances接口在EDAS中代购ECS实例,并将代购的实例扩容到指定的应用分组。
ScaleOutApplication扩容应用实例调用ScaleOutApplication接口扩容应用。
ScaleInApplication缩容应用实例使用ScaleInApplication缩容应用实例。
ResetApplication重置应用重置一个应用。
RestartApplication重启应用适用于ECS应用。
K8s集群专属K8s集群专属
CreateK8sService创建K8s服务为K8s集群中的应用创建K8s服务Service。
BindK8sSlb绑定SLB到集群中的应用绑定SLB到容器服务K8s集群中的应用。
DeleteK8sApplication删除容器服务K8s应用调用DeleteK8sApplication接口删除容器服务K8s应用。
DeleteK8sService删除K8s服务删除K8s集群中应用的K8s服务Service。
UnbindK8sSlb解绑容器服务 k8s 应用的 SLB调用UnbindK8sSlb解绑容器服务k8s应用的SLB。
UpdateK8sApplicationBaseInfo更新K8s应用基本信息调用UpdateK8sApplicationBaseInfo接口修改K8s应用基本信息。
UpdateK8sApplicationConfig修改K8s集群中应用配置调用UpdateK8sApplicationConfig接口修改容器服务K8s或Serverless K8s集群中应用的配置。
StartK8sApplication启动K8s应用启动容器服务K8s或Serverless K8s集群中的应用。
StopK8sApplication停止K8s应用停止部署在容器服务K8s集群或Serverless K8s集群中的应用。
UpdateK8sSlb更新K8s负载均衡SLB调用UpdateK8sSlb更新容器服务K8s应用绑定的负载均衡SLB。
UpdateK8sService更新K8s服务更新K8s集群中应用的K8s服务Service。
UpdateSlsLogStore配置应用的日志服务调用UpdateSlsLogStore接口配置应用的日志服务。
GetK8sApplication获取K8s应用信息调用GetK8sApplication接口获取容器服务K8s集群或Serverless K8s集群中部署的应用信息。
GetK8sServices获取K8s服务Service列表调用GetK8sServices接口获取K8s集群中应用的服务Service列表。
QuerySlsLogStoreList查询应用的日志服务配置详情调用 QuerySlsLogStoreList 接口查询应用的日志服务配置详情。
GetAppDeployment获取K8s应用的Deployment信息调用GetAppDeployment接口获取K8s应用的Deployment信息。
DescribeAppInstanceList查询K8s应用实例列表调用DescribeAppInstanceList接口查询K8s应用实例列表。
GetK8sAppPrecheckResult获取K8s应用预检结果调用GetK8sAppPrecheckResult接口获取K8s应用预检结果。
InsertK8sApplication创建K8s应用调用InsertK8sApplication接口在容器服务K8s集群或Serverless K8s集群中创建应用。
DeployK8sApplication部署K8s应用调用DeployK8sApplication接口在容器服务K8s集群或Serverless K8s集群中部署应用。
ScaleK8sApplication扩容或下线容器服务K8s集群应用实例调用ScaleK8sApplication接口扩容或下线容器服务K8s集群的应用实例。
RestartK8sApplication重启K8s应用调用RestartK8sApplication接口来重启部署在容器服务K8s集群或Serverless K8s集群中的应用。
ConvertK8sResource将资源转化为应用调用ConvertK8sResource接口将一个Deployment资源转化为应用。
AbortAndRollbackChangeOrder终止并回滚变更单调用AbortAndRollbackChangeOrder接口终止并回滚变更单,适用于容器服务K8s集群中的应用。
StartK8sAppPrecheck开始K8s应用变更预检调用StartK8sAppPrecheck接口开始K8s应用变更预检。 。

服务管理

API标题API概述
InsertServiceGroup创建服务分组调用InsertServiceGroup创建服务分组。
DeleteServiceGroup删除服务分组调用DeleteServiceGroup删除服务分组。
GetServiceConsumersPage查询微服务消费者列表调用GetServiceConsumersPage接口获取服务消费者列表。
GetServiceListPage查询微服务列表调用GetServiceListPage接口获取服务列表。
GetServiceMethodPage查询微服务方法列表调用GetServiceMethodPage接口获取服务接口元数据列表。
GetServiceProvidersPage查询微服务提供者列表调用GetServiceProvidersPage接口获取服务提供者列表。
ListConsumedServices查询消费的服务调用ListConsumedServices查询消费的服务。
ListPublishedServices查询发布的服务调用ListPublishedServices查询发布的服务。
GetServiceDetail获取服务详情调用GetServiceDetail接口获取服务详情。
ListMethods查询服务方法列表调用ListMethods接口查询服务方法列表。
ListServiceGroups查询服务分组列表调用ListServiceGroups查询HSF应用的服务分组列表。

应用路由

API标题API概述
CreateK8sIngressRule创建应用路由规则调用CreateK8sIngressRule接口创建应用路由规则。
DeleteK8sIngressRule删除应用路由规则调用DeleteK8sIngressRule接口删除应用路由规则。
UpdateK8sIngressRule更新应用路由规则调用UpdateK8sIngressRule接口更新应用路由规则。
ListK8sIngressRules获取应用路由列表调用ListK8sIngressRules接口获取应用路由列表。

配置管理

API标题API概述
CreateConfigTemplate创建配置模板调用CreateConfigTemplate接口创建配置模板。 。
CreateK8sConfigMap创建K8s配置项调用CreateK8sConfigMap接口创建K8s配置项。
CreateK8sSecret创建K8s保密配置调用CreateK8sSecret接口创建K8s保密配置。
DeleteConfigTemplate删除配置模板调用DeleteConfigTemplate接口删除配置模板。
DeleteK8sConfigMap删除K8s配置项调用DeleteK8sConfigMap接口删除K8s配置项。
DeleteK8sSecret删除K8s保密配置调用DeleteK8sSecret接口删除K8s保密配置。
UpdateConfigTemplate更新配置模板调用UpdateConfigTemplate接口更新配置模板。 。
RetryChangeOrderTask重试失败的发布单任务调用RetryChangeOrderTask接口重试失败的发布单任务。
UpdateK8sConfigMap更新K8s配置项调用UpdateK8sConfigMap接口更新K8s配置项。
UpdateK8sSecret更新K8s保密配置调用UpdateK8sSecret接口更新K8s保密配置。
ListConfigTemplates获取配置模板列表调用ListConfigTemplates接口获取配置模板列表。
GetJavaStartUpConfig获取应用的Java启动参数配置调用GetJavaStartUpConfig接口获取应用的Java启动参数配置。
GetWebContainerConfig获取应用的Tomcat配置调用GetWebContainerConfig接口获取应用的Tomcat配置。
ListK8sConfigMaps获取K8s配置项列表调用ListK8sConfigMaps接口获取K8s配置项列表。
ListK8sSecrets获取K8s保密配置列表调用ListK8sSecrets接口获取K8s保密配置列表。

弹性伸缩

API标题API概述
CreateApplicationScalingRule创建应用弹性伸缩规则调用CreateApplicationScalingRule接口创建应用的弹性伸缩规则。
DeleteApplicationScalingRule删除应用弹性伸缩规则调用DeleteApplicationScalingRule接口删除应用的弹性伸缩规则。
DisableApplicationScalingRule禁用应用弹性伸缩规则调用DisableApplicationScalingRule接口禁用应用弹性伸缩规则。
EnableApplicationScalingRule启用应用弹性伸缩规则调用EnableApplicationScalingRule接口启用应用弹性伸缩规则。
UpdateApplicationScalingRule更新应用的弹性伸缩规则调用UpdateApplicationScalingRule接口更新应用的弹性伸缩规则。
DescribeApplicationScalingRules获取应用弹性策略调用DescribeApplicationScalingRules接口获取应用的弹性策略。

其他

API标题API概述
DeleteSwimmingLane删除泳道删除全链路流量控制流控泳道。
InsertSwimmingLane新建泳道新建泳道。
InsertSwimmingLaneGroup新建泳道组新建泳道组。
ListSwimmingLane获取泳道列表获取泳道组下的泳道列表。
ListSwimmingLaneGroup获取泳道组列表获取泳道组列表。
UpdateSwimmingLane更新泳道
UpdateSwimmingLaneGroup更新泳道组更新泳道组。
阿里云首页 企业级分布式应用服务 EDAS 相关技术圈