本产品(
企业级分布式应用服务/2017-08-01
)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
系统管理
API | 标题 | API概述 |
---|---|---|
DeleteRole | 删除角色 | 删除角色。 |
UpdateRole | 编辑角色 | 编辑角色。 |
UpdateAccountInfo | 编辑账号信息 | 编辑账号信息。 |
ListRole | 获取角色列表 | 获取角色列表。 |
ListSubAccount | 获取子账号列表 | 获取子账号和RAM用户列表。 |
ListAuthority | 查询所有权限 | 查询所有权限。 |
GetPackageStorageCredential | 获取临时存储包所需的STS | 获取临时存储包所需的STS。 |
InsertRole | 创建角色 | 创建角色。 |
AuthorizeRole | 授权角色 | 授权角色。 |
AuthorizeApplication | 为子账号授权应用 | 为子账号或RAM用户授予应用的操作权限。 |
AuthorizeResourceGroup | 为子账号授予资源组的操作权限 | 为子账号或RAM用户授予指定资源组的操作权限。 |
资源管理
API | 标题 | API概述 |
---|---|---|
ECS集群和K8s集群 | ECS集群和K8s集群 | |
DeleteUserDefineRegion | 删除指定的自定义命名空间 | 删除指定的自定义命名空间。 |
DeleteCluster | 删除集群 | 用于删除ECS集群或取消导入K8s集群。 |
ListAliyunRegion | 获取阿里云地域列表 | 获取阿里云地域列表。 |
QueryMigrateRegionList | 查询可供迁移的命名空间列表 | 查询可供迁移的命名空间列表。 |
ListCluster | 获取集群列表 | 获取集群列表。 |
GetCluster | 获取集群信息 | 获取指定集群的信息。 |
ListVpc | 获取 VPC 列表 | 获取VPC列表,该接口适用于ECS集群和K8s集群。 |
QueryRegionConfig | 获取不同地域的配置内容 | 获取不同地域的配置内容。 |
ListApplicationEcu | 获取ECU列表 | 获取ECU列表。 |
ListResourceGroup | 查询资源组信息 | 获取资源组列表。 |
ListTagResources | 查询资源绑定的标签列表 | 查询云资源已经绑定的标签列表。 |
TagResources | 为资源绑定标签 | 调用TagResources为指定的资源统一创建并绑定标签。 |
UntagResources | 删除资源标签 | 调用UntagResources接口为指定的资源列表统一解绑标签。 |
ECS集群 | ECS集群 | |
CreateIDCImportCommand | 生成非阿里云ECS集群的导入命令 | 调用CreateIDCImportCommand接口生成非阿里云ECS集群的导入命令。 |
DeleteClusterMember | 删除集群实例 | 调用DeleteClusterMember接口删除集群实例。 |
DeleteEcu | 删除指定的 ECU | 删除指定的 ECU。 |
ListClusterMembers | 获取ECS实例列表 | 获取ECS实例列表。 |
ListEcuByRegion | 获取指定命名空间下可用的ECU列表 | 获取指定命名空间下可用的ECU列表。 |
ListConvertableEcu | 列出可导入到指定集群的ECS实例列表 | 调用ListConvertableEcu接口列出可导入到指定集群的ECS实例列表。本API适用于ECS集群。 |
ListEcsNotInCluster | 获取所有未导入集群的 ECS | 调用ListEcsNotInCluster接口获取所有未导入集群的ECS实例。 |
QueryMigrateEcuList | 查询可迁移的实例列表 | 调用QueryMigrateEcuList来查询可迁移的实例列表。 |
ListScaleOutEcu | 获取用于应用扩容的ECU列表 | 从指定集群或应用关联集群获取可用于应用扩容的ECU列表。该接口仅适用于ECS集群。 |
ListSlb | 获取SLB列表 | 获取SLB列表。 |
BindSlb | 绑定SLB到指定应用 | 调用BindSlb接口绑定SLB到指定应用。 |
InsertCluster | 创建集群 | 调用InsertCluster接口创建集群。 |
InsertClusterMember | 向ECS集群中导入ECS实例 | 向ECS集群中导入ECS实例。 |
InstallAgent | 安装 Agent | 使用ECS自带的云助手安装EDAS Agent(将ECS导入EDAS)。 |
TransformClusterMember | 导入或转移ECS实例 | 接口导入或转移ECS实例。 |
MigrateEcu | 转移ECU到指定命名空间的默认集群 | 转移ECU到指定命名空间的默认集群。 |
SynchronizeResource | 同步阿里云基础资源到EDAS | 同步用户下的阿里云基础资源到EDAS。适用于ECS集群。 |
K8s集群 | K8s集群 | |
UpdateK8sResource | 更新容器服务K8s资源 | 更新K8s资源。 |
GetK8sCluster | 获取K8s集群列表 | 获取容器服务K8s集群或Serverless K8s集群列表。 |
ListK8sNamespaces | 获取K8s命名空间列表 | 调用ListK8sNamespaces接口获取K8s命名空间列表。 |
ImportK8sCluster | 导入容器服务K8s集群 | 调用ImportK8sCluster接口导入容器服务K8s集群或Serverless K8s集群。 |
应用管理
API | 标题 | API概述 |
---|---|---|
ECS集群和K8s集群通用 | ECS集群和K8s集群通用 | |
UpdateHealthCheckUrl | 设置健康检查 URL | 调用UpdateHealthCheckUrl来设置健康检查URL。 |
GetChangeOrderInfo | 查看变更流程详情 | 调用GetChangeOrderInfo接口查看变更流程详情。 |
GetSecureToken | 获取命名空间SecureToken信息 | 调用GetSecureToken获取指定命名空间的SecureToken信息,主要是用来获取指定命名空间的AccessKey ID、AccessKey Secret 、TenantId、地址服务器域名等信息。 |
QueryEccInfo | 查询ECC信息 | 适用于容器服务K8s集群。 |
GetScalingRules | 获取扩缩容规则 | 调用GetScalingRules接口获取扩缩容规则。 |
ListUserDefineRegion | 获取用户自定义命名空间列表 | 获取用户自定义命名空间列表。 |
GetContainerConfiguration | 获取应用或分组的 Tomcat 设置 | 调用GetContainerConfiguration接口获取应用或应用分组的Tomcat配置。 |
ListApplication | 获取应用列表 | 获取应用列表。 |
ListDeployGroup | 获取部署分组列表 | 调用ListDeployGroup接口获取部署分组列表。 |
ListHistoryDeployVersion | 应用发布历史版本列表 | 调用ListHistoryDeployVersion接口,获取应用部署的历史版本列表。 |
ListRecentChangeOrder | 列出应用历史变更单列表 | 调用ListRecentChangeOrder列出应用历史变更单列表。 |
ListBuildPack | 获取容器版本列表 | 调用ListBuildPack接口获取容器版本列表。 |
InsertOrUpdateRegion | 创建或编辑自定义命名空间 | 调用InsertOrUpdateRegion接口创建或编辑自定义命名空间。 |
SwitchAdvancedMonitoring | 查询或启停高级监控 | 调用SwitchAdvancedMonitoring接口查询ECS和K8s集群中应用高级监控开关状态及控制接口。 |
ContinuePipeline | 执行下一批发布 | 调用ContinuePipeline接口手动确认执行下一批发布。 |
AbortChangeOrder | 终止变更流程 | 调用AbortChangeOrder接口终止变更流程。 |
RollbackChangeOrder | 回滚变更单 | 调用RollbackChangeOrder终止应用的变更流程,并回滚应用。该接口适用于ECS集群中的应用。 |
ECS集群专属 | ECS集群专属 | |
UpdateApplicationBaseInfo | 修改应用名称 | 描述信息、Owner信息。 |
AddLogPath | 添加日志目录 | 适用于在阿里云和非阿里云ECS集群中部署的应用。 |
DeleteApplication | 删除应用实例 | 调用DeleteApplication接口删除应用实例。 |
DeleteLogPath | 删除日志目录 | 适用于在阿里云和非阿里云ECS集群中部署的应用。 |
DeleteDeployGroup | 删除分组 | 调用DeleteDeployGroup来删除分组。 |
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。 |
GetJvmConfiguration | 获取应用或分组的 JVM 设置 | 调用GetJvmConfiguration接口获取应用或应用分组的JVM设置。 |
GetApplication | 获取应用信息 | 获取ECS集群中指定应用的信息。 。 |
ListComponents | 查询组件列表 | 调用ListComponents接口查询组件列表,本API适用于ECS集群中的应用。 |
QueryApplicationStatus | 查询应用状态 | 调用QueryApplicationStatus接口查询应用状态。 |
InsertDeployGroup | 创建应用部署分组 | 调用InsertDeployGroup接口创建应用分组。 |
BindEcsSlb | 来给部署在ECS集群中的应用绑定SLB | 调用BindEcsSlb接口来给部署在ECS集群中的应用绑定SLB。 |
UnbindSlb | 解除绑定SLB | 调用UnbindSlb接口解除绑定SLB。 |
RollbackApplication | 回滚应用 | 调用RollbackApplication接口回滚应用。 |
InsertApplication | 创建 ECS 集群的应用 | 调用InsertApplication接口在ECS集群中创建应用。 |
DeployApplication | 用于向 ECS 集群部署应用 | 调用DeployApplication接口在ECS集群中部署应用。 |
ScaleoutApplicationWithNewInstances | 代购实例并扩容到指定分组 | 在EDAS中代购ECS实例,并将代购的实例扩容到指定的应用分组。 |
ScaleOutApplication | 扩容应用实例 | 调用ScaleOutApplication接口扩容应用。 |
ScaleInApplication | 缩容应用实例 | 使用ScaleInApplication缩容应用实例。 |
ResetApplication | 重置应用 | 重置一个应用。 |
RestartApplication | 重启应用 | 适用于ECS应用。 |
K8s集群专属 | K8s集群专属 | |
CreateK8sService | 创建K8s服务 | 为K8s集群中的应用创建K8s服务Service。 |
DeleteK8sApplication | 删除容器服务K8s应用 | 调用DeleteK8sApplication接口删除容器服务K8s应用。 |
DeleteK8sService | 删除K8s服务 | 删除K8s集群中应用的K8s服务Service。 |
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接口配置应用的日志服务。 |
StartK8sAppPrecheck | 开始K8s应用变更预检 | 调用StartK8sAppPrecheck接口开始K8s应用变更预检。 |
GetK8sApplication | 获取K8s应用信息 | 获取容器服务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应用预检结果。 |
BindK8sSlb | 绑定SLB到集群中的应用 | 绑定SLB到容器服务K8s集群中的应用。 |
UnbindK8sSlb | 解绑容器服务 k8s 应用的 SLB | 调用UnbindK8sSlb解绑容器服务k8s应用的SLB。 |
InsertK8sApplication | 创建K8s应用 | 在容器服务K8s集群或Serverless K8s集群中创建应用。 |
DeployK8sApplication | 部署K8s应用 | 在容器服务K8s集群或Serverless K8s集群中部署应用。 |
ScaleK8sApplication | 扩容或下线容器服务K8s集群应用实例 | 扩容或下线容器服务K8s集群的应用实例。 |
RestartK8sApplication | 重启K8s应用 | 调用RestartK8sApplication接口来重启部署在容器服务K8s集群或Serverless K8s集群中的应用。 |
ConvertK8sResource | 将资源转化为应用 | 将一个Deployment资源转化为应用。 |
AbortAndRollbackChangeOrder | 终止并回滚变更单 | 调用AbortAndRollbackChangeOrder接口终止并回滚变更单,适用于容器服务K8s集群中的应用。 |
服务管理
API | 标题 | API概述 |
---|---|---|
DeleteServiceGroup | 删除服务分组 | 调用DeleteServiceGroup删除服务分组。 |
GetServiceConsumersPage | 查询微服务消费者列表 | 获取服务消费者列表。 |
GetServiceListPage | 查询微服务列表 | 调用GetServiceListPage接口获取服务列表。 |
GetServiceMethodPage | 查询微服务方法列表 | 调用GetServiceMethodPage接口获取服务接口元数据列表。 |
GetServiceProvidersPage | 查询微服务提供者列表 | 调用GetServiceProvidersPage接口获取服务提供者列表。 |
ListConsumedServices | 查询消费的服务 | 调用ListConsumedServices查询消费的服务。 |
ListPublishedServices | 查询发布的服务 | 调用ListPublishedServices查询发布的服务。 |
GetServiceDetail | 获取服务详情 | 获取服务详情。 |
ListMethods | 查询服务方法列表 | 调用ListMethods接口查询服务方法列表。 |
ListServiceGroups | 查询服务分组列表 | 调用ListServiceGroups查询HSF应用的服务分组列表。 |
InsertServiceGroup | 创建服务分组 | 调用InsertServiceGroup创建服务分组。 |
应用路由
API | 标题 | API概述 |
---|---|---|
CreateK8sIngressRule | 创建应用路由规则 | 调用CreateK8sIngressRule接口创建应用路由规则。 |
DeleteK8sIngressRule | 删除应用路由规则 | 调用DeleteK8sIngressRule接口删除应用路由规则。 |
UpdateK8sIngressRule | 更新应用路由规则 | 更新应用路由规则。 |
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接口更新配置模板。 。 |
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保密配置列表。 |
RetryChangeOrderTask | 重试失败的发布单任务 | 调用RetryChangeOrderTask接口重试失败的发布单任务。 |
弹性伸缩
API | 标题 | API概述 |
---|---|---|
CreateApplicationScalingRule | 创建应用弹性伸缩规则 | 调用CreateApplicationScalingRule接口创建应用的弹性伸缩规则。 |
DeleteApplicationScalingRule | 删除应用弹性伸缩规则 | 调用DeleteApplicationScalingRule接口删除应用的弹性伸缩规则。 |
DisableApplicationScalingRule | 禁用应用弹性伸缩规则 | 调用DisableApplicationScalingRule接口禁用应用弹性伸缩规则。 |
EnableApplicationScalingRule | 启用应用弹性伸缩规则 | 调用EnableApplicationScalingRule接口启用应用弹性伸缩规则。 |
UpdateApplicationScalingRule | 更新应用的弹性伸缩规则 | 调用UpdateApplicationScalingRule接口更新应用的弹性伸缩规则。 |
DescribeApplicationScalingRules | 获取应用弹性伸缩规则 | 调用DescribeApplicationScalingRules接口获取应用的弹性伸缩规则。 |
泳道管理
API | 标题 | API概述 |
---|---|---|
InsertSwimmingLaneGroup | 新建泳道组 | 新建泳道组。 |
InsertSwimmingLane | 新建泳道 | 新建泳道。 |
DeleteSwimmingLane | 删除泳道 | 删除全链路流量控制流控泳道。 |
UpdateSwimmingLaneGroup | 更新泳道组 | 更新泳道组。 |
UpdateSwimmingLane | 更新泳道 | |
ListSwimmingLaneGroup | 获取泳道组列表 | 获取泳道组列表。 |
ListSwimmingLane | 获取泳道列表 | 获取泳道组下的泳道列表。 |