edit-icon download-icon

ListScaleOutEcuRequest

Last Updated: Jan 16, 2018

Function

Returns a list of available instances when an application is created or scaled up.

Request URL

/pop/v5/resource/scale_out_ecu_list

Request method

GET

Request parameters – When a common application is created

Parameter Type Required? Description
logicalRegionId String No ID of a logical region (regionId is replaced with this parameter after it is set.)
clusterId String Yes Cluster ID
instanceNum Integer No Number of expected available ECS instances. By default, a full list of available ECS instances is returned.

Request parameters – When a Docker application is created

Parameter Type Required? Description
logicalRegionId String No ID of a logical region (regionId is replaced with this parameter after it is set.)
clusterId String Yes Cluster ID
cpu Integer Yes A list of ECS instances with required amount of CPU cores
mem Integer Yes A list of ECS instances with required amount of memory (MB)
instanceNum Integer Yes Number of expected available ECS instances. This parameter is required when a Docker application is created.

Request parameters – When an application is scaled up

Parameter Type Required? Description
logicalRegionId String No ID of a logical region (regionId is replaced with this parameter after it is set.)
appId String Yes Application ID
groupId String No ID of the group where the ECS instance to be scaled up is located. If this parameter is not set, the default group is used.
instanceNum Integer Yes Number of expected available ECS instances

Response parameters

Parameter Type Description
Code Integer Response code
Message String Response message
Data List A list of cluster entities

EcuInfoEntity

Parameter Type Description
EcuId String Unique ID of an ECU instance, which can be obtained by running dmidecode on ECS
Online Boolean If the ECS instance is online and under EDAS control or not
DockerEnv Boolean If Docker is installed for the ECU instance or not
CreateTime Long Creation time, in milliseconds
UpdateTime Long Last change time, in milliseconds
HeartbeatTime Long Heartbeat time, in milliseconds
IpAddr String Intranet IP address of the ECU instance
UserId String Administrator account name
Name String ECS instance name
ZoneId String ID of the zone where the ECS instance is located
RegionId String ID of the region where the ECS instance is located
VpcId String ID of the VPC where the ECS instance is located
AvailableCpu Long Number of available CPU cores of the ECS instance
AvailableMem Long Available memory (MB) of the ECS instance
Thank you! We've received your feedback.