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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadCluster	Read	All Resources *	none	none

Request syntax

POST /pop/v5/resource/scale_out_ecu_list

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 parameters

Parameter	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 []	The ECUs.
VpcId	string	The ID of the virtual private cloud (VPC) where the ECU is located.	vpc-2zef6ob8**********
UpdateTime	long	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	long	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	long	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.