DescribeEciScalingConfigurations - Auto Scaling - Alibaba Cloud ドキュメントセンター

Queries scaling configurations of the Elastic Container Instance type. When you call the DescribeEciScalingConfigurations operation, you can specify the scaling group ID, scaling configuration ID, or scaling configuration name to query the details of the desired scaling configuration, such as the instance bidding policy, instance type of the container group, image pulling policy of containers, and load balancing weight of each elastic container instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
ess:DescribeEciScalingConfigurations	get	ScalingGroup acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the scaling group to which the scaling configuration belongs.	cn-qingdao
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	50
ScalingGroupId	string	No	The ID of the scaling group. You can use the ID to query all scaling configurations in the scaling group.	asg-bp17pelvl720x3v7****
ScalingConfigurationIds	array	No	The IDs of the scaling configurations that you want to query. You can specify 1 to 10 scaling configuration IDs. The IDs of active and inactive scaling configurations are displayed in the query results. You can distinguish between active and inactive scaling configurations based on the value of `LifecycleState`.
	string	No	The ID of the scaling configuration that you want to query. The IDs of active and inactive scaling configurations are displayed in the query results. You can distinguish between active and inactive scaling configurations based on the value of LifecycleState.	asc-bp17pelvl720x5ub****
ScalingConfigurationNames	array	No	The names of the scaling configurations that you want to query. You can specify 1 to 10 scaling configuration names. The names of inactive scaling configurations are not displayed in the query results, and no error is reported.
	string	No	The name of scaling configuration that you want to query. The names of inactive scaling configurations are not displayed in the query results, and no error is reported.	scalingcon****

Response parameters

Parameter	Type	Description	Example
	object	The response information.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	50
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of scaling configurations.	1
ScalingConfigurations	array<object>	The scaling configurations.
ScalingConfiguration	object	Details of the scaling configurations.
CreationTime	string	The time at which the scaling configuration was created.	2014-08-14T10:58Z
ScalingConfigurationName	string	The name of the scaling configuration.	scalingconfi****
SecurityGroupId	string	The ID of the security group with which elastic container instances are associated. Elastic container instances that are associated with the same security group can communicate with each other.	sg-bp18kz60mefs****
ActiveDeadlineSeconds	integer	The validity period of the scaling configuration. Unit: seconds.	1000
SpotStrategy	string	The bidding policy for elastic container instances. Valid values: NoSpot: The instances are created as regular pay-as-you-go instances. SpotWithPriceLimit: The instances are created as preemptible instances with a user-defined maximum hourly price. SpotAsPriceGo: The instances are created as preemptible instances for which the market price at the time of purchase is automatically used as the bid price.	NoSpot
AutoCreateEip	boolean	Indicates whether elastic IP addresses (EIPs) are automatically created and bound to elastic container instances.	true
ScalingGroupId	string	The ID of the scaling group to which the scaling configuration belongs.	asg-bp17pelvl720x3v7****
EphemeralStorage	integer	The capacity of the ephemeral storage. Unit: GiB.	20
Ipv6AddressCount	integer	The number of IPv6 addresses.	1
Description	string	Note This parameter is not available for use.	This is an example.
EipBandwidth	integer	The EIP bandwidth. Default value: 5. Unit: Mbit/s.	5
ImageSnapshotId	string	The ID of the image cache.	imc-2zebxkiifuyzzlhl****
Memory	float	The memory size. You can specify CPU and Memory to define the range of instance types. For example, if you set CPU to 2 and Memory to 16, the instance types that have 2 vCPUs and 16 GiB are returned. After you specify CPU and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones and preferentially creates instances by using the lowest-priced instance type. Note You can specify CPU and Memory to define instance types only if you set Scaling Policy to Cost Optimization and no instance type is specified in the scaling configuration.	16
RestartPolicy	string	The restart policy of elastic container instances. Valid values: Never: Elastic container instances are never restarted. Always: Elastic container instances are always restarted. OnFailure: Elastic container instances are restarted upon failures.	Never
SpotPriceLimit	float	The maximum hourly price for preemptible elastic container instances. This parameter is returned only if you set SpotStrategy to SpotWithPriceLimit.	0.025
IngressBandwidth	long	The maximum inbound public bandwidth. Unit: bit/s.	1024000
CpuOptionsThreadsPerCore	integer	The number of threads per core. This parameter can be specified for only specific instance types. A value of 1 indicates that Hyper-Threading is disabled. For more information, see Specify CPU options.	2
TerminationGracePeriodSeconds	integer	The buffer time during which a program handles operations before the program stops.	60
LoadBalancerWeight	integer	The load balancing weight of each elastic container instance as a backend server. Valid values: 1 to 100.	1
DnsPolicy	string	The Domain Name System (DNS) policy.	Default
HostName	string	The hostname series.	['hehe.com', 'haha.com']
EgressBandwidth	long	The maximum outbound public bandwidth. Unit: bit/s.	1024000
RegionId	string	The region ID of elastic container instances.	cn-hangzhou
RamRoleName	string	The Resource Access Management (RAM) role of elastic container instances. Elastic container instances and Elastic Compute Service (ECS) instances can share the same RAM role. For more information, see Use an instance RAM role by calling API operations.	ram:PassRole
Cpu	float	The number of vCPUs per elastic container instance.	2.0
AutoMatchImageCache	boolean	Indicates whether the image cache is automatically matched. Default value: false.	false
ResourceGroupId	string	The ID of the resource group.	rg-8db03793gfrz****
ContainerGroupName	string	The name series of elastic container instances.	test
ScalingConfigurationId	string	The ID of the scaling configuration.	asc-bp1ezrfgoyn5kijl****
CpuOptionsCore	integer	The number of physical CPU cores. This parameter can be specified for only specific instance types. For more information, see Specify CPU options.	2
SlsEnable	boolean	Note This parameter is not available for use.	False
Containers	array<object>	The containers in an elastic container instance.
Container	object	The containers in the elastic container instance.
ReadinessProbeHttpGetPath	string	The path to which HTTP GET requests are sent when you use the HTTP GET requests to perform readiness probes.	/usr/local
ReadinessProbeSuccessThreshold	integer	The minimum number of consecutive successes before a failed readiness probe is considered successful. Default value: 1. Valid value: 1.	1
LivenessProbePeriodSeconds	integer	The interval at which liveness probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.	5
LivenessProbeTcpSocketPort	integer	The port detected by TCP sockets when you use the TCP sockets to perform liveness probes.	80
LivenessProbeHttpGetScheme	string	The protocol type of HTTP GET requests when you use the HTTP GET requests to perform liveness probes. Valid values: HTTP HTTPS	HTTP
WorkingDir	string	The working directory.	/usr/local/nginx
Tty	boolean	Indicates whether the Interaction feature is enabled. Valid values: true false If the command is a /bin/bash command, the value of this parameter is true. Default value: false.	false
LivenessProbeHttpGetPort	integer	The port to which HTTP GET requests are sent to perform liveness probes.	80
Gpu	integer	The number of GPUs.	1
ReadinessProbeInitialDelaySeconds	integer	The number of seconds that elapses from the startup of the container to the start time of a readiness probe.	5
Stdin	boolean	Indicates whether the container allocates buffer resources to standard input streams when the container is running. If this parameter is not specified, an end-of-file (EOF) error may occur when standard input streams in the container are read. Default value: false.	true
Memory	float	The memory size per container.	2.0
Name	string	The custom name of the container.	nginx
SecurityContextReadOnlyRootFilesystem	boolean	Indicates whether the root file system on which the container runs is read-only. Valid value: true.	true
LivenessProbeHttpGetPath	string	The path to which HTTP GET requests are sent when you use the HTTP GET requests to perform liveness probes.	/usr/nginx/
Image	string	The container image.	mysql
ReadinessProbeTcpSocketPort	integer	The port detected by TCP sockets when you use the TCP sockets to perform readiness probes.	8888
ReadinessProbeHttpGetScheme	string	The protocol type of HTTP GET requests when you use the HTTP requests to perform readiness probes. Valid values: HTTP HTTPS	HTTP
ReadinessProbeHttpGetPort	integer	The path to which HTTP GET requests are sent when you use the HTTP GET requests to perform readiness probes.	/usr/nginx/
LivenessProbeSuccessThreshold	integer	The minimum number of consecutive successes before a failed liveness probe is considered successful. Default value: 1. Valid value: 1.	1
ReadinessProbeTimeoutSeconds	integer	The timeout period of a readiness probe. Default value: 1. Minimum value: 1. Unit: seconds.	5
SecurityContextRunAsUser	long	The ID of the user that runs the entry point of the container process.	1000
LivenessProbeInitialDelaySeconds	integer	The number of seconds that elapses from the startup of the container to the start time of a liveness probe.	10
ReadinessProbePeriodSeconds	integer	The interval at which readiness probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.	1
ImagePullPolicy	string	The image pulling policy. Valid values: Always: Each time image pulling is performed. IfNotPresent: Image pulling is performed as needed. On-premises images are preferentially used. If no on-premises images are available, image pulling is performed. Never: On-premises images are always used. Image pulling is not performed.	Always
StdinOnce	boolean	Indicates whether standard input streams are disconnected after a client is disconnected. If Stdin is set to true, standard input streams remain connected among multiple sessions. If StdinOnce is set to true, standard input streams are connected after the container is started, and remain idle until a client is connected to receive data. After the client is disconnected, streams are also disconnected, and remain disconnected until the container restarts.	true
Cpu	float	The number of vCPUs per container.	2.0
LivenessProbeTimeoutSeconds	integer	The timeout period of a liveness probe. Default value: 1. Minimum value: 1. Unit: seconds.	10
ReadinessProbeFailureThreshold	integer	The minimum number of consecutive failures before a successful readiness probe is considered failed. Default value: 3.	3
LivenessProbeFailureThreshold	integer	The minimum number of consecutive failures before a successful liveness probe is considered failed. Default value: 3.	3
Ports	array<object>	The exposed ports and protocols.
Port	object	The exposed ports and protocols of the container.
Port	integer	The port number. Valid values: 1 to 65535.	8888
Protocol	string	The protocol type. Valid values: TCP UDP	TCP
VolumeMounts	array<object>	The mounted volumes.
VolumeMount	object	The volumes that are mounted on the container.
ReadOnly	boolean	Indicates whether the volume is read-only. Default value: false.	false
SubPath	string	The volume subdirectory.	data2/
Name	string	The volume name. The value of this parameter is the same as the name of the volume that is mounted to containers.	default-volume1
MountPropagation	string	The mount propagation settings. Mount propagation enables volumes mounted on one container to be shared among other containers within the same pod or across distinct pods residing on the same node. Valid values: None: Subsequent mounts executed either on the volume itself or its subdirectories do not propagate to the already established volume mount. HostToCotainer: Subsequent mounts executed either on the volume itself or its subdirectories propagate to the already established volume mount. Bidirectional: This value is similar to HostToCotainer. Subsequent mounts executed either on the volume itself or its subdirectories propagate to the already established volume mount. In addition, any volume mounts executed on a container not only propagate back to the underlying host but also to all containers across every pod that uses the same volume. Default value: None.	None
MountPath	string	The directory to which the volume is mounted. Note Data in this directory is overwritten by the data on the volume. Proceed with caution if you specify this parameter.	/pod/data
EnvironmentVars	array<object>	The environment variables.
EnvironmentVar	object	Details of the environment variables.
Key	string	The name of the environment variable.	PATH
Value	string	The value of the environment variable.	/usr/bin/
FieldRefFieldPath	string	Note This parameter is not available for use.	path
Commands	array	The container startup commands. You can specify up to 20 commands. Each command can contain up to 256 characters.
Command	string	The container startup command. You can specify up to 20 commands. Each command contains up to 256 characters.	sleep
LivenessProbeExecCommands	array	The commands that are run in the container when you use the CLI to perform liveness probes.
LivenessProbeExecCommand	string	The command that is run in the container when you use a CLI to perform a liveness probe.	cat/tmp/healthy
Args	array	The container startup arguments. You can specify up to 10 arguments.
Arg	string	The container startup argument. You can specify up to 10 arguments.	100
ReadinessProbeExecCommands	array	The commands that are run in the container when you use the CLI to perform readiness probes.
ReadinessProbeExecCommand	string	The command that is run in the container when you use a CLI to perform a readiness probe.	cat/tmp/healthy
SecurityContextCapabilityAdds	array	The permissions that are granted to the processes in the container. Valid values: NET_ADMIN and NET_RAW. Note To use NET_RAW, you must submit a ticket.
InitContainerSecurityContextCapabilityAdd	string	The permissions that are granted to the process in the container. Valid values: NET_ADMIN and NET_RAW. Note To use NET_RAW, you must submit a ticket.	NET_ADMIN
LifecyclePostStartHandlerHttpGetHost	string	The IP address of the host to which HTTP GET requests for configuring the postStart callback function are sent.	10.0.XX.XX
LifecyclePostStartHandlerHttpGetPort	integer	The port over which HTTP GET requests for configuring the postStart callback function are sent.	80
LifecyclePostStartHandlerHttpGetPath	string	The path to which HTTP GET requests for configuring the postStart callback function are sent.	/healthyz
LifecyclePostStartHandlerHttpGetScheme	string	The protocol type of the HTTP GET requests that are sent for configuring the postStart callback function.	HTTP
LifecyclePostStartHandlerExecs	array	The commands that are run for configuring the postStart callback function by using the CLI within the container.
LifecyclePostStartHandlerExec	string	The command that is run for configuring the postStart callback function by using the CLI within the container.	["/bin/sh", "-c","echo Hello from the preStop handler > /usr/share/message"]
LifecyclePostStartHandlerTcpSocketHost	string	The IP address of the host detected by the TCP sockets used for configuring the postStart callback function.	10.0.XX.XX
LifecyclePostStartHandlerTcpSocketPort	integer	The port detected by the TCP sockets used for configuring the postStart callback function.	80
LifecyclePreStopHandlerHttpGetHost	string	The IP address of the host to which HTTP GET requests for configuring the preStop callback function are sent.	10.0.XX.XX
LifecyclePreStopHandlerHttpGetPort	integer	The port over which HTTP GET requests for configuring the preStop callback function are sent.	80
LifecyclePreStopHandlerHttpGetPath	string	The path to which HTTP GET requests for configuring the preStop callback function are sent.	/healthyz
LifecyclePreStopHandlerHttpGetScheme	string	The protocol type of the HTTP Get requests that are sent for configuring the preStop callback function.	HTTP
LifecyclePreStopHandlerExecs	array	The commands that are run for configuring the preStop callback function by using the CLI within the container.
LifecyclePreStopHandlerExec	string	The commands that is run for configuring the preStop callback function by using the CLI within the container.	["/bin/sh", "-c","echo Hello from the preStop handler > /usr/share/message"]
LifecyclePreStopHandlerTcpSocketHost	string	The IP address of the host detected by the TCP sockets used for configuring the preStop callback function.	10.0.XX.XX
LifecyclePreStopHandlerTcpSocketPort	integer	The port detected by the TCP sockets used for configuring the preStop callback function.	80
InitContainers	array<object>	The init containers.
InitContainer	object	The init containers.
SecurityContextReadOnlyRootFilesystem	boolean	Indicates whether the root file system is read-only. Valid value: true.	true
ImagePullPolicy	string	The image pulling policy.	Always
WorkingDir	string	The working directory.	/usr/local
Cpu	float	The number of vCPUs per init container.	0.5
Image	string	The image of the init container.	nginx
Gpu	integer	The number of GPUs per init container.	1
SecurityContextRunAsUser	string	The ID of the user that runs the init container.	587
Memory	float	The memory size per init container.	1.0
Name	string	The name of the init container.	test-init
InitContainerEnvironmentVars	array<object>	The environment variables.
InitContainerEnvironmentVar	object	Details of the environment variables.
Key	string	The name of the environment variable.	PATH
Value	string	The value of the environment variable.	/usr/local/bin
FieldRefFieldPath	string	Note This parameter is not available for use.	path
InitContainerPorts	array<object>	The ports of the init container.
InitContainerPort	object	Details of the init container ports.
Port	integer	The port number. Valid values: 1 to 65535.	1
Protocol	string	The protocol type. Valid values: TCP UDP	TCP
InitContainerVolumeMounts	array<object>	The volumes that are mounted to the init container.
InitContainerVolumeMount	object	The volumes that are mounted on the container.
ReadOnly	boolean	Indicates whether the mount directory is read-only. Default value: false.	false
SubPath	string	The volume subdirectory. A pod can mount different directories of the same volume to different directories of the init container.	/usr/sub/
Name	string	The volume name.	test-empty
MountPropagation	string	The mount propagation setting. Mount propagation enables volumes mounted on one container to be shared among other containers within the same pod or across distinct pods residing on the same node. Valid values: None: Subsequent mounts executed either on the volume itself or its subdirectories do not propagate to the already established volume mount. HostToCotainer: Subsequent mounts executed either on the volume itself or its subdirectories propagate to the already established volume mount. Bidirectional: This value is similar to HostToCotainer. Subsequent mounts executed either on the volume itself or its subdirectories propagate to the already established volume mount. In addition, any volume mounts executed on a container not only propagate back to the underlying host but also to all containers across every pod that uses the same volume. Default value: None.	None
MountPath	string	The directory to which the volume is mounted. Data under this directory is overwritten by the data on the volume.	/usr/share/
SecurityContextCapabilityAdds	array	The permissions that are granted to the processes in the init container. Valid values: NET_ADMIN and NET_RAW. Note To use NET_RAW, you must submit a ticket.
InitContainerSecurityContextCapabilityAdd	string	The permissions that are granted to the process in the init container. Valid values: NET_ADMIN and NET_RAW. Note To use NET_RAW, you must submit a ticket.	NET_ADMIN
InitContainerCommands	array	The container startup commands.
InitContainerCommand	string	The container startup command.	sleep
InitContainerArgs	array	The container startup arguments.
InitContainerArg	string	The container startup argument.	10
Tags	array<object>	The tags of elastic container instances. Tags are specified in the key-value format.
Tag	object	The tags of the elastic container instance. The tags are specified in the key-value pair format.
Key	string	The tag key.	version
Value	string	The tag value.	3
Volumes	array<object>	The volumes.
Volume	object	Details of the volumes.
Type	string	The volume type. Valid values: EmptyDirVolume NFSVolume ConfigFileVolume FlexVolume	EmptyDirVolume
DiskVolumeDiskId	string	The size of the disk volume. Unit: GiB.	15
DiskVolumeFsType	string	The system type of the disk volume.	xfs
EmptyDirVolumeMedium	string	The storage medium of the emptyDir volume. If you do not specify a storage medium for the emptyDir volume, the volume stores data in the file system of a node by default. We recommend that you set this parameter to memory. In this case, the emptyDir volume stores data in the specified memory.	memory
NFSVolumePath	string	The path to the Network File System (NFS) volume.	/share
DiskVolumeDiskSize	integer	The size of the disk volume. Unit: GiB.	15
NFSVolumeReadOnly	boolean	Indicates whether the NFS volume is read-only. Default value: false.	false
FlexVolumeFsType	string	The type of the mounted file system. The default value is determined by the script of FlexVolume.	ext4
ConfigFileVolumeDefaultMode	integer	The default permissions on the ConfigFile volume.	0644
FlexVolumeDriver	string	The name of the FlexVolume driver.	flexvolume
FlexVolumeOptions	string	The FlexVolume options. Each option is a key-value pair in a JSON string. For example, if you use FlexVolume to mount a disk, the format of Options is `{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}`.	{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}
NFSVolumeServer	string	The endpoint of the NFS server.	3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com
Name	string	The volume name.	default-volume1
ConfigFileVolumeConfigFileToPaths	array<object>	The paths to configuration files.
ConfigFileVolumeConfigFileToPath	object	The paths to configuration files.
Path	string	The relative path to the configuration file.	/usr/bin/
Mode	integer	The permissions on the ConfigFile volume.	0644
Content	string	The content of the configuration file (32 KB).	bGl1bWk=
EmptyDirVolumeSizeLimit	string	The storage size of the emptyDir volume.	256Mi
HostPathVolumeType	string	The type of the HostPath volume.	Directory
HostPathVolumePath	string	The path to the HostPath volume on the host.	/pod/data
ImageRegistryCredentials	array<object>	The information about the image repository.
ImageRegistryCredential	object	The information about the image repository.
Password	string	The password of the image repository.	yourpaasword
Server	string	The domain name of the image repository.	registry-vpc.cn-shanghai.aliyuncs.com
UserName	string	The username of the image repository.	yourusername
DnsConfigOptions	array<object>	The options. Each option is a name-value pair. The value in the name-value pair is optional.
DnsConfigOption	object	The options. Each option is a name-value pair. The value in the name-value pair is optional.
Name	string	The variable name of the option.	name
Value	string	The variable value of the option.	value
HostAliases	array<object>	The hostnames and IP addresses for a container that are added to the hosts file of the elastic container instance.
HostAlias	object	The hostname aliases of a container.
Ip	string	The added IP address.	192.0.XX.XX
Hostnames	array	The added hostnames.
Hostname	string	The added hostname.	['hehe.com', 'haha.com']
SecurityContextSysCtls	array<object>	The system information of the security context in which the elastic container instance runs.
SecurityContextSysCtl	object	The system information of the security context in which the elastic container instance runs.
Name	string	The system name of the security context in which the elastic container instance runs.	kernel.msgmax
Value	string	The variable value of the security context in which the elastic container instance runs.	65536
AcrRegistryInfos	array<object>	The Container Registry Enterprise Edition instances.
AcrRegistryInfo	object	Details of the Container Registry Enterprise Edition instances.
InstanceId	string	The ID of the Container Registry Enterprise Edition instance.	cri-nwj395hgf6f3****
InstanceName	string	The name of the Container Registry Enterprise Edition instance.	acr-test
RegionId	string	The region ID of the Container Registry Enterprise Edition instance.	cn-hangzhou
Domains	array	The domain names of the Container Registry Enterprise Edition instance. By default, all domain names of the instance are displayed. Multiple domain names are separated by commas (,).
Domain	string	The domain name of the Container Registry Enterprise Edition instance. By default, all domain names of the instance are displayed. Multiple domain names are separated by commas (,).	***-**-registry.cn-beijing.cr.aliyuncs.com
DnsConfigNameServers	array	The IP addresses of the Domain Name Service (DNS) server.
DnsConfigNameServer	string	The IP address of the DNS server.	172.10..*
DnsConfigSearches	array	The search domains of the DNS servers.
DnsConfigSearche	string	The search domains of the DNS server.	svc.local.kubenetes
NtpServers	array	The endpoints of the Network Time Protocol (NTP) server.
NtpServer	string	The endpoint of the NTP server.	ntp.cloud.aliyuncs.com
LifecycleState	string	The status of the scaling configuration in the scaling group. Valid values: Active: The scaling configuration is active in the scaling group. Auto Scaling uses the scaling configuration that is in the Active state to create instances during scale-out events. Inactive: The scaling configuration is inactive in the scaling group. Scaling configurations that are in the Inactive state are still contained in the scaling group, but Auto Scaling does not use the inactive scaling configurations to create instances during scale-out events.	Active
CostOptimization	boolean	Indicates whether the Cost Optimization feature is enabled. Valid values: true false	false
InstanceFamilyLevel	string	The level of the instance family, which is used to filter the available instance types that meet the specified requirements. This parameter takes effect only if `CostOptimization` is set to true. Valid values: EntryLevel: entry level (shared instance types). Instance types of this level are the most cost-effective but may not provide stable computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low. For more information, see Shared instance families. EnterpriseLevel: enterprise level. Instance types of this level provide stable performance and dedicated resources, and are suitable for business scenarios that require high stability. For more information, see Overview of instance families. CreditEntryLevel: credit-based entry level (burstable instance types). CPU credits are used to ensure computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see Overview of burstable instances.	EnterpriseLevel
InstanceTypes	array	The specified ECS instance types. You can specify up to five instance types.
InstanceType	string	The specified ECS instance type. You can specify up to five instance types. For more information, see Specify ECS instance types to create an elastic container instance.	ecs.g6.large
DataCacheBucket	string	The bucket that stores the data cache.	default
DataCachePL	string	The performance level (PL) of the cloud disk that stores the data cache. We recommend that you use enterprise SSDs (ESSDs). Valid values: PL0: An ESSD can provide up to 10,000 random read/write IOPS. PL1: An ESSD can provide up to 50,000 random read/write IOPS. PL2: An ESSD can provide up to 100,000 random read/write IOPS. PL3: An ESSD can provide up to 1,000,000 random read/write IOPS. Note For more information about ESSDs, see ESSDs .	PL1
DataCacheProvisionedIops	integer	The provisioned read/write IOPS of the ESSD AutoPL disk that stores the data cache. Valid values: 0 to min{50,000, 1000 x Capacity - Baseline IOPS}. Baseline IOPS = min{1,800 + 50 x Capacity, 50,000}. Note For more information about ESSD AutoPL disks, see ESSD AutoPL disks.	40000
DataCacheBurstingEnabled	boolean	Indicates whether the Performance Burst feature is enabled for the ESSD AutoPL disk that stores the data cache. Valid values: true false Note For more information about ESSD AutoPL disks, see ESSD AutoPL disks.	false

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "ScalingConfigurations": [
    {
      "CreationTime": "2014-08-14T10:58Z",
      "ScalingConfigurationName": "scalingconfi****",
      "SecurityGroupId": "sg-bp18kz60mefs****",
      "ActiveDeadlineSeconds": 1000,
      "SpotStrategy": "NoSpot",
      "AutoCreateEip": true,
      "ScalingGroupId": "asg-bp17pelvl720x3v7****",
      "EphemeralStorage": 20,
      "Ipv6AddressCount": 1,
      "Description": "This is an example.",
      "EipBandwidth": 5,
      "ImageSnapshotId": "imc-2zebxkiifuyzzlhl****",
      "Memory": 16,
      "RestartPolicy": "Never",
      "SpotPriceLimit": 0.025,
      "IngressBandwidth": 1024000,
      "CpuOptionsThreadsPerCore": 2,
      "TerminationGracePeriodSeconds": 60,
      "LoadBalancerWeight": 1,
      "DnsPolicy": "Default",
      "HostName": "['hehe.com', 'haha.com']",
      "EgressBandwidth": 1024000,
      "RegionId": "cn-hangzhou",
      "RamRoleName": "ram:PassRole",
      "Cpu": 2,
      "AutoMatchImageCache": false,
      "ResourceGroupId": "rg-8db03793gfrz****",
      "ContainerGroupName": "test",
      "ScalingConfigurationId": "asc-bp1ezrfgoyn5kijl****",
      "CpuOptionsCore": 2,
      "SlsEnable": true,
      "Containers": [
        {
          "ReadinessProbeHttpGetPath": "/usr/local",
          "ReadinessProbeSuccessThreshold": 1,
          "LivenessProbePeriodSeconds": 5,
          "LivenessProbeTcpSocketPort": 80,
          "LivenessProbeHttpGetScheme": "HTTP",
          "WorkingDir": "/usr/local/nginx",
          "Tty": false,
          "LivenessProbeHttpGetPort": 80,
          "Gpu": 1,
          "ReadinessProbeInitialDelaySeconds": 5,
          "Stdin": true,
          "Memory": 2,
          "Name": "nginx",
          "SecurityContextReadOnlyRootFilesystem": true,
          "LivenessProbeHttpGetPath": "/usr/nginx/",
          "Image": "mysql",
          "ReadinessProbeTcpSocketPort": 8888,
          "ReadinessProbeHttpGetScheme": "HTTP",
          "ReadinessProbeHttpGetPort": 0,
          "LivenessProbeSuccessThreshold": 1,
          "ReadinessProbeTimeoutSeconds": 5,
          "SecurityContextRunAsUser": 1000,
          "LivenessProbeInitialDelaySeconds": 10,
          "ReadinessProbePeriodSeconds": 1,
          "ImagePullPolicy": "Always",
          "StdinOnce": true,
          "Cpu": 2,
          "LivenessProbeTimeoutSeconds": 10,
          "ReadinessProbeFailureThreshold": 3,
          "LivenessProbeFailureThreshold": 3,
          "Ports": [
            {
              "Port": 8888,
              "Protocol": "TCP"
            }
          ],
          "VolumeMounts": [
            {
              "ReadOnly": false,
              "SubPath": "data2/",
              "Name": "default-volume1",
              "MountPropagation": "None",
              "MountPath": "/pod/data"
            }
          ],
          "EnvironmentVars": [
            {
              "Key": "PATH",
              "Value": "/usr/bin/",
              "FieldRefFieldPath": "path"
            }
          ],
          "Commands": [
            "sleep"
          ],
          "LivenessProbeExecCommands": [
            "cat/tmp/healthy"
          ],
          "Args": [
            "100"
          ],
          "ReadinessProbeExecCommands": [
            "cat/tmp/healthy"
          ],
          "SecurityContextCapabilityAdds": [
            "NET_ADMIN"
          ],
          "LifecyclePostStartHandlerHttpGetHost": "10.0.XX.XX",
          "LifecyclePostStartHandlerHttpGetPort": 80,
          "LifecyclePostStartHandlerHttpGetPath": "/healthyz",
          "LifecyclePostStartHandlerHttpGetScheme": "HTTP",
          "LifecyclePostStartHandlerExecs": [
            "[\"/bin/sh\", \"-c\",\"echo Hello from the preStop handler > /usr/share/message\"]"
          ],
          "LifecyclePostStartHandlerTcpSocketHost": "10.0.XX.XX",
          "LifecyclePostStartHandlerTcpSocketPort": 80,
          "LifecyclePreStopHandlerHttpGetHost": "10.0.XX.XX",
          "LifecyclePreStopHandlerHttpGetPort": 80,
          "LifecyclePreStopHandlerHttpGetPath": "/healthyz\n",
          "LifecyclePreStopHandlerHttpGetScheme": "HTTP",
          "LifecyclePreStopHandlerExecs": [
            "[\"/bin/sh\", \"-c\",\"echo Hello from the preStop handler > /usr/share/message\"]"
          ],
          "LifecyclePreStopHandlerTcpSocketHost": "10.0.XX.XX",
          "LifecyclePreStopHandlerTcpSocketPort": 80
        }
      ],
      "InitContainers": [
        {
          "SecurityContextReadOnlyRootFilesystem": true,
          "ImagePullPolicy": "Always",
          "WorkingDir": "/usr/local",
          "Cpu": 0.5,
          "Image": "nginx",
          "Gpu": 1,
          "SecurityContextRunAsUser": "587",
          "Memory": 1,
          "Name": "test-init",
          "InitContainerEnvironmentVars": [
            {
              "Key": "PATH",
              "Value": "/usr/local/bin",
              "FieldRefFieldPath": "path"
            }
          ],
          "InitContainerPorts": [
            {
              "Port": 1,
              "Protocol": "TCP"
            }
          ],
          "InitContainerVolumeMounts": [
            {
              "ReadOnly": false,
              "SubPath": "/usr/sub/",
              "Name": "test-empty",
              "MountPropagation": "None",
              "MountPath": "/usr/share/"
            }
          ],
          "SecurityContextCapabilityAdds": [
            "NET_ADMIN"
          ],
          "InitContainerCommands": [
            "sleep"
          ],
          "InitContainerArgs": [
            "10"
          ]
        }
      ],
      "Tags": [
        {
          "Key": "version",
          "Value": "3"
        }
      ],
      "Volumes": [
        {
          "Type": "EmptyDirVolume",
          "DiskVolumeDiskId": "15",
          "DiskVolumeFsType": "xfs",
          "EmptyDirVolumeMedium": "memory",
          "NFSVolumePath": "/share",
          "DiskVolumeDiskSize": 15,
          "NFSVolumeReadOnly": false,
          "FlexVolumeFsType": "ext4",
          "ConfigFileVolumeDefaultMode": 644,
          "FlexVolumeDriver": "flexvolume",
          "FlexVolumeOptions": "{\"volumeId\":\"d-2zehdahrwoa7srg****\",\"performanceLevel\": \"PL2\"}",
          "NFSVolumeServer": "3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com",
          "Name": "default-volume1",
          "ConfigFileVolumeConfigFileToPaths": [
            {
              "Path": "/usr/bin/",
              "Mode": 644,
              "Content": "bGl1bWk="
            }
          ],
          "EmptyDirVolumeSizeLimit": "256Mi",
          "HostPathVolumeType": "Directory",
          "HostPathVolumePath": "/pod/data"
        }
      ],
      "ImageRegistryCredentials": [
        {
          "Password": "yourpaasword",
          "Server": "registry-vpc.cn-shanghai.aliyuncs.com",
          "UserName": "yourusername\t\n"
        }
      ],
      "DnsConfigOptions": [
        {
          "Name": "name",
          "Value": "value"
        }
      ],
      "HostAliases": [
        {
          "Ip": "192.0.XX.XX",
          "Hostnames": [
            "['hehe.com', 'haha.com']"
          ]
        }
      ],
      "SecurityContextSysCtls": [
        {
          "Name": "kernel.msgmax",
          "Value": "65536"
        }
      ],
      "AcrRegistryInfos": [
        {
          "InstanceId": "cri-nwj395hgf6f3****",
          "InstanceName": "acr-test",
          "RegionId": "cn-hangzhou",
          "Domains": [
            "*****-****-registry.cn-beijing.cr.aliyuncs.com"
          ]
        }
      ],
      "DnsConfigNameServers": [
        "172.10.*.**"
      ],
      "DnsConfigSearches": [
        "svc.local.kubenetes"
      ],
      "NtpServers": [
        "ntp.cloud.aliyuncs.com"
      ],
      "LifecycleState": "Active",
      "CostOptimization": false,
      "InstanceFamilyLevel": "EnterpriseLevel",
      "InstanceTypes": [
        "ecs.g6.large"
      ],
      "DataCacheBucket": "default",
      "DataCachePL": "PL1",
      "DataCacheProvisionedIops": 40000,
      "DataCacheBurstingEnabled": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
403	Forbidden.RiskControl	Forbidden.RiskControl

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

Change history

Change time	Summary of changes	Operation
2024-01-23	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-14	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-11	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-12	The Error code has changed. The response structure of the API has changed	View Change Details