ListScaleOutEcu - Enterprise Distributed Application Service

Queries elastic compute units (ECUs) available for scaling out an application in a specified cluster or the cluster where the application is deployed. This operation is applicable to Elastic Compute Service (ECS) clusters.

Operation description

Terms

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 namespace and custom namespaces. Each region has a default namespace and supports multiple custom namespaces. By default, only the default namespace is available. You do not need to create a custom 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadCluster

get

*All Resource

*

None

Request syntax

POST /pop/v5/resource/scale_out_ecu_list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
LogicalRegionId	string	No	The ID of the namespace. The ID of a custom namespace is in the `region ID:namespace identifier` format. Example: cn-beijing:test. The ID of the default namespace is in the `region ID` format. Example: cn-beijing.	cn-beijing:test
ClusterId	string	No	The ID of the cluster. Specify this parameter if you want to query the available ECUs in the cluster. Note Specify at least one of the ClusterId and AppId parameters as the query parameter.	52984524-6d48-4bbd-******************
AppId	string	No	The ID of the application. Specify this parameter if you want to query the available ECUs in the cluster where the application is deployed. Note Specify at least one of the ClusterId and AppId parameters as the query parameter.	b93024fd-8a9d-4ef7-99f1-5f0d65cc****
GroupId	string	No	The ID of the instance group. Specify this parameter if you want to query the available ECUs in the cluster where the instance group resides.	8123db90-880f-486f-**-**
Cpu	integer	No	The number of CPU cores based on which you want to query the available ECUs in the cluster.	1
Mem	integer	No	The size of available memory based on which you want to query the available ECUs in the cluster. Unit: MB.	200
InstanceNum	integer	No	The number of ECUs that you want to query. If this parameter is not specified, all the ECUs that meet the query conditions are returned.	1

Response elements

Element	Type	Description	Example
	object	The content that is returned.
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	AF860D6C-ACE3-4429-9D54-3BD15A******
EcuInfoList	object
EcuInfo	array<object>	The ECUs.
	object	The information about ECUs.
VpcId	string	The ID of the virtual private cloud (VPC) where the ECU is located.	vpc-2zef6ob8**********
UpdateTime	integer	The time when the ECU was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1573281040827
IpAddr	string	The private IP address of the ECU.	192.168.XX.XX
AvailableCpu	integer	The number of available CPU cores for the ECU.	2
CreateTime	integer	The time when the ECU was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1573281040819
UserId	string	The ID of the Alibaba Cloud account to which the ECU belongs.	1172**6608**
InstanceId	string	The ID of the ECU.	i-2zej4i2jdf*********
RegionId	string	The ID of the region where the ECU is located.	cn-beijing
EcuId	string	The unique ID of the ECU. To query the ID, you can run the `dmidecode` command on the ECS instance that corresponds to the ECU.	0de2ebdb-9490-4fc4-be41***************
Online	boolean	Indicates whether the ECU is online. If the ECU is online, its corresponding ECS instance is managed in EDAS. Valid values: true: The ECU is online. false: The ECU is offline.	true
DockerEnv	boolean	Indicates whether Docker is installed. Valid values: true: Docker is installed. false: Docker is not installed.	false
AvailableMem	integer	The size of available memory for the ECU. Unit: MB.	111
ZoneId	string	The ID of the zone where the ECU resides.	cn-beijing-h
Name	string	The name of the ECU.	test
HeartbeatTime	integer	The time when the last heartbeat detection was performed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1573281040819

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "AF860D6C-ACE3-4429-9D54-3BD15A******",
  "EcuInfoList": {
    "EcuInfo": [
      {
        "VpcId": "vpc-2zef6ob8**********",
        "UpdateTime": 1573281040827,
        "IpAddr": "192.168.XX.XX",
        "AvailableCpu": 2,
        "CreateTime": 1573281040819,
        "UserId": "1172****6608****",
        "InstanceId": "i-2zej4i2jdf*********",
        "RegionId": "cn-beijing",
        "EcuId": "0de2ebdb-9490-4fc4-be41***************",
        "Online": true,
        "DockerEnv": false,
        "AvailableMem": 111,
        "ZoneId": "cn-beijing-h",
        "Name": "test",
        "HeartbeatTime": 1573281040819
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.