The following tables list API operations available for use in Enterprise Distributed Application Service (EDAS). The operations are related to Elastic Compute Service (ECS) clusters.
Note You can create two types of ECS clusters: Alibaba Cloud ECS clusters and hybrid cloud
ECS clusters.
- Assume that you have created an Alibaba Cloud ECS cluster. You can purchase ECS instances in the ECS cluster in the EDAS console to create applications. You can also purchase ECS instances in the ECS console and import the instances to the ECS cluster to create applications. For more information about how to create an ECS cluster, see Create an ECS cluster by using the console.
- Assume that you have created a hybrid cloud ECS cluster. You can connect instances from Alibaba Cloud, data centers, and other cloud service providers to EDAS over Express Connect circuits. You can add the instances to the ECS clusters that are deployed on Alibaba Cloud and hosted in EDAS. For more information about how to create a hybrid cloud ECS cluster, see Create hybrid cloud ECS clusters.
Background information
The following section introduces some concepts that are used in the API operations related to ECS clusters.
- Region: the region that is displayed in the top navigation bar of each service console, such as China (Hangzhou), China (Shanghai), and China (Beijing).
- Microservice Namespace: the logical concept that is used to isolate resources such as clusters, ECS instances, and applications, and microservices published in EDAS. This concept involves the default microservice namespace and custom microservice namespaces. Each region has a default microservice namespace and supports multiple custom microservice namespaces. By default, only the default microservice namespace is available. You do not need to create a custom microservice namespace if you do not want to isolate resources and microservices.
- Elastic compute unit (ECU): After an ECS instance is imported to a cluster, the instance becomes an ECU.
- Elastic compute container (ECC): After you deploy an application to an ECU in a cluster, the ECU becomes an ECC.
Resource management
API | Description | Supported cluster type |
---|---|---|
ListAliyunRegion | Queries Alibaba Cloud regions. Each region has a default microservice namespace. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListEcuByRegion | Queries the instances that have been imported to EDAS based on a specified region ID. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
MigrateEcu | Migrates the ECS instances that have been imported to EDAS to a specified microservice namespace. | Alibaba Cloud ECS clusters |
QueryMigrateRegionList | Queries the microservice namespaces to which an instance can be migrated. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
QueryMigrateEcuList | Queries the ECS instances that are imported to EDAS and can be migrated. | Alibaba Cloud ECS clusters |
QueryRegionConfig | Queries the configuration information of the instances in a specified region. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListApplicationEcu | Queries ECUs. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteEcu | Deletes a specified ECU. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListScaleOutEcu | Queries the ECS instances that are available for you to create or scale out an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
SynchronizeResource | Synchronizes the basic resources of Alibaba Cloud to EDAS. | Alibaba Cloud ECS clusters |
InsertCluster | Creates a cluster. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteCluster | Deletes a cluster. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListConvertableEcu | Queries the ECS instances that can be imported to a specified cluster. | Alibaba Cloud ECS clusters |
ListEcsNotInCluster | Queries all the ECS instances that are not imported to a cluster. | Alibaba Cloud ECS clusters |
InsertClusterMember | Adds an ECS instance to a cluster. | Alibaba Cloud ECS clusters |
ListClusterMembers | Queries instances by cluster ID. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteClusterMember | Deletes an instance from a cluster. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetCluster | Queries the details about a cluster. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListCluster | Queries clusters. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
TransformClusterMember | Migrates or imports ECS instances from one cluster to another cluster.
Notice ECS instances that are not imported to a cluster cannot be migrated to another cluster.
|
Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
InstallAgent | Installs EDAS Agent. | Alibaba Cloud ECS clusters |
ListResourceGroup | Queries resource groups. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListSlb | Queries Server Load Balancer (SLB) instances. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListVpc | Queries virtual private clouds (VPCs). | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetPackageStorageCredential | Queries the Security Token Service (STS) credentials that are required for temporary storage. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
MoveResourceGroup | Migrates the specified EDAS resource to an existing resource group. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
Application management
Microservice namespacesAPI | Description | Supported cluster type |
---|---|---|
InsertOrUpdateRegion | Creates or modifies a custom microservice namespace. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteUserDefineRegion | Deletes a custom microservice namespace. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListUserDefineRegion | Queries custom microservice namespaces. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetSecureToken | Queries the security token information of a specified microservice namespace. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
API | Description | Supported cluster type |
---|---|---|
InsertApplication | Creates an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeployApplication | Deploys an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetApplication | Queries the detailed information about an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteApplication | Deletes an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListApplication | Queries applications. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ScaleOutApplication | Scales out an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ScaleInApplication | Scales in or unpublishes an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ModifyScalingRule | Configures scaling rules. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetScalingRules | Queries scaling rules. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
StartApplication | Starts an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
StopApplication | Stops an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ResetApplication | Resets an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
RestartApplication | Restarts an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
RollbackApplication | Rolls back an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
API | Description | Supported cluster type |
---|---|---|
ListApplicationEcc | Queries the ECC information. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateHookConfiguration | Configures the mount script for an application or an instance group. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
QueryApplicationStatus | Queries the status of an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateApplicationBaseInfo | Modifies the application information, including the application name, description, and owner information. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListHistoryDeployVersion | Queries historical deployment packages of an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
BindEcsSlb | Binds an SLB instance. | Alibaba Cloud ECS clusters |
UnbindSlb | Unbinds an SLB instance. | Alibaba Cloud ECS clusters |
InsertDeployGroup | Creates an instance group for a specified application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ChangeDeployGroup | Changes the group of an instance where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteDeployGroup | Deletes an instance group where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListDeployGroup | Queries the instance groups where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateContainer | Updates the runtime environment of an application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateHealthCheckUrl | Configures a health check URL. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetContainerConfiguration | Queries the Tomcat configuration information for an application or the instance group where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateContainerConfiguration | Configures the Tomcat container for an application or the instance group where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetJvmConfiguration | Queries the Java Virtual Machine (JVM) settings of an application or the instance group where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateJvmConfiguration | Configures JVM settings for an application or the instance group where a specified application is deployed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListBuildPack | Queries container versions. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListComponents | Queries the components related to applications in Elastic Compute Service (ECS) clusters in a region. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetChangeOrderInfo | Queries the details about a change process. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListRecentChangeOrder | Queries change orders. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
AbortChangeOrder | Terminates a change process. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
RollbackChangeOrder | Rolls back a change process. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ContinuePipeline | Specifies whether to manually trigger the release for the next batch. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
AddLogPath | Adds a log directory. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteLogPath | Removes a log directory. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
System administration
API | Description | Supported cluster type |
---|---|---|
AuthorizeApplication | Grants a sub-account or a RAM user the permissions on a specified application. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
AuthorizeResourceGroup | Grants a sub-account or a RAM user the permissions on a specified resource group. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
AuthorizeRole | Grants permissions to a specified role. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
DeleteRole | Deletes a role. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListAuthority | Queries all permissions. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListRole | Queries roles. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListSubAccount | Queries sub-accounts. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
InsertRole | Creates a role. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateAccountInfo | Modifies the account information. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
UpdateRole | Modifies a role. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
Service management
API | Description | Supported cluster type |
---|---|---|
DeleteServiceGroup | Deletes a service group. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
InsertServiceGroup | Creates a service group. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListConsumedServices | Queries the services that are consumed. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListPublishedServices | Queries the published services. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListServiceGroups | Queries service groups. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
ListMethods | Queries service methods. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
Service query
API | Description | Supported cluster type |
---|---|---|
GetServiceProvidersPage | Queries the providers of a service. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetServiceConsumersPage | Queries the consumers of a service. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetServiceMethodPage | Queries the service interface metadata. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetServiceListPage | Queries services. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |
GetServiceDetail | Queries the details about a service. | Alibaba Cloud ECS clusters and hybrid cloud ECS clusters |