This topic lists the ECS cluster APIs Enterprise Distributed Application Service EDAS.

Note ECS clusters belong to Alibaba Cloud and non-Alibaba Cloud.
  • In Alibaba Cloud ECS clusters, you can purchase ECS instances in the EDAS ECS cluster on your behalf to create applications. Alternatively, you can purchase ECS instances in the ECS console and import them to the ECS cluster to create applications. For more information about ECS clusters, see Create an ECS cluster.
  • You can connect ECS instances from Alibaba Cloud, on-premises IDCs, and other cloud service providers (CSPs) through leased lines, and add the instances to non-Alibaba Cloud ECS clusters. For more information about non-Alibaba Cloud ECS clusters, see Deploy applications in hybrid cloud clusters.

Background information

API operations for ECS clusters are described as follows:

  • Region: The regions displayed in the top navigation bar of each service console include China (Hangzhou), China (Shanghai), and China (Beijing).
  • Namespace: Tt is a logical concept designed in EDAS to isolate resources such as clusters, ECS instances, applications, and microservices published in EDAS. Includes a default namespace and a custom namespace. Each region contains one default namespace and several custom namespaces. Only the default namespace is used by default. If you do not want to isolate resources and microservices, you do not need to create a custom namespace.
  • ECU: The ECS instance is an ECU after it is imported to the cluster.
  • ECC: The ECUs of the cluster become ECC after being deployed in the application.

Resource Management

Name Description Supported cluster types
ListAliyunRegion Obtain the Alibaba Cloud region ( Region each region has a corresponding default namespace. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListEcuByRegion You can call this operation to retrieve the list of EDAS instances that have been imported to a region based on the specified region ID. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
MigrateEcu Migrate ECS instances in EDAS to the specified namespace Alibaba Cloud ECS clusters
QueryMigrateRegionList Query the list of namespaces available for migration Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
QueryMigrateEcuList Query available ECS instances in EDAS during migration. Alibaba Cloud ECS clusters
QueryRegionConfig Queries the configuration information of an Alibaba Cloud physical Region. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListApplicationEcu Obtain the ECU list Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteEcu Deletes a specified ECU. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListScaleOutEcu Obtains a list of available ECS instances before an application or scale-out. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
SynchronizeResource Synchronize Alibaba cloud resources to EDAS Alibaba Cloud ECS clusters
InsertCluster Create a cluster Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteCluster Delete a cluster Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListConvertableEcu Obtains the ECS instances that have been imported to a specified cluster. Alibaba Cloud ECS clusters
ListEcsNotInCluster Obtain all ECS instances that have not been imported to the cluster Alibaba Cloud ECS clusters
InsertClusterMember Add ECS instances to a cluster Alibaba Cloud ECS clusters
ListClusterMembers Obtain instances by cluster ID Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteClusterMember You can call this operation to delete an Elastic Compute Service (ECS) instance from a cluster. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetCluster Obtains the detailed information about a cluster. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListCluster Obtains the cluster list. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
TransformClusterMember You can call this operation to transfer or import ECS instances from one cluster to another.
Notice ECS instances that have not been imported to the cluster cannot be transferred to another cluster.
Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
InstallAgent Install EDAS Agent Alibaba Cloud ECS clusters
ListResourceGroup Obtains a resource group list. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListSlb Query SLB list Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListVpc Query the VPC list Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetPackageStorageCredential In exchange for STS required by a temporary storage package Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters

Application management

Namespace management
Name Description Supported cluster types
InsertOrUpdateRegion Create or edit user-defined namespaces Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteUserDefineRegion Delete custom namespaces Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListUserDefineRegion Obtains a list of custom namespaces. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetSecureToken Obtain the SecureToken information of the specified namespace. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
Lifecycle management
Name Description Supported cluster types
InsertApplication Create an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeployApplication Deploy an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetApplication Queries application information. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteApplication Deletes an application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListApplication You can call this operation to query applications. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ScaleOutApplication You can call this operation to scale out an application by adding one or more Elastic Compute Service (ECS) instances. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ScaleInApplication Scale out or remove an application instance Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ModifyScalingRule Set Expansion rules Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetScalingRules Obtain scaling rules Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
StartApplication Start an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
StopApplication Stop an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ResetApplication You can call this operation to reset an application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
RestartApplication Restart an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
RollbackApplication Roll back an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
Apply to All Workspaces
Name Description Supported cluster types
QueryEccInfo Query ECC information Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
QueryApplicationStatus You can call this operation to query the information of an application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateApplicationBaseInfo Modify the application name, description, and Owner. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListHistoryDeployVersion You can call this operation to query historical deployment package versions of an application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
BindEcsSlb Bind an SLB instance Alibaba Cloud ECS clusters
UnbindSlb Unbind SLB Alibaba Cloud ECS clusters
InsertDeployGroup Create a deployment Group Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ChangeDeployGroup Change Deployment Group Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteDeployGroup Deletes a deployment Group. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListDeployGroup Queries deployment groups. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateContainer Update the runtime environment of an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateHealthCheckUrl Set health check URL Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetContainerConfiguration Obtains the Tomcat configuration information under the application or group. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateContainerConfiguration Set Tomcat information in an application or application Group Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetJvmConfiguration Get JVM settings for applications or groups Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateJvmConfiguration Set the JVM group under the application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListBuildPack You can call this operation to query versions of Enterprise Distributed Application Service (EDAS) Container where an application is running. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListComponents Query a list of components Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
GetChangeOrderInfo View change process details Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListRecentChangeOrder The information about the most recent change process returned. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
AbortChangeOrder Terminate the change order Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
RollbackChangeOrder Rollback change order Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ContinuePipeline Manually confirm the execution of the next batch Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
QueryMonitorInfo Query monitoring information Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters

System administration

Name Description Supported cluster types
AuthorizeApplication Authorize an application Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
AuthorizeResourceGroup Authorize a resource group Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
AuthorizeRole Grant permissions to the ESS default role Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
DeleteRole Delete a role Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListAuthority You can call this operation to query all permissions defined in Enterprise Distributed Application Service (EDAS). Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListRole You can call this operation to query roles defined in Enterprise Distributed Application Service (EDAS). Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListSubAccount Obtain sub-account column Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
InsertRole You can call this operation to create a role. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateAccountInfo You can call this operation to edit the information about an account. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
UpdateRole Modify a role Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters

Manage a service

Name Description Supported cluster types
DeleteServiceGroup You can call this operation to delete a service group. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
InsertServiceGroup The name of the service group that you want to create. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListConsumedServices You can call this operation to query services consumed by an application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListPublishedServices You can call this operation to query services published by an application. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListPublishedServices You can call this operation to query service groups. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters
ListMethods Queries the method list of a service. Alibaba Cloud ECS clusters and non-Alibaba Cloud ECS clusters