ECI Scaling Configuration API Reference - Auto Scaling - Alibaba Cloud - Auto Scaling

Queries the details of a scaling configuration by ID, including the temporary storage size, number of IPv6 addresses, and elastic IP address (EIP) bandwidth. The output can be returned in YAML format.

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

ess:DescribeEciScalingConfigurationDetail

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

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-beijing
ScalingGroupId	string	No	The ID of the scaling group to which the scaling configuration belongs.	asg-bp1ffogfdauy0jw0****
ScalingConfigurationId	string	Yes	The ID of the scaling configuration based on which elastic container instances are created.	asc-bp1ffogfdauy0nu5****
OutputFormat	string	No	The output format. Set the value to YAML. Valid values: YAML : YAML	yaml

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6EF9BFEE-FE07-4627-B8FB-14326FB9****
ScalingConfiguration	object	The information about the scaling configuration.
CreationTime	string	The time when the scaling configuration was created.	2023-05-10T02:39:15Z
ScalingConfigurationName	string	The name of the scaling configuration.	scalingconfi****
SecurityGroupId	string	The ID of the security group with which the elastic container instance is associated. Elastic container instances that are associated with the same security group can access each other.	sg-bp18kz60mefs****
ActiveDeadlineSeconds	integer	The validity period of the scaling configuration. Unit: seconds.	60
SpotStrategy	string	The preemption policy of the instance. Valid values: NoSpot: The instance is created as a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is used as the bid price.	NoSpot
AutoCreateEip	boolean	Indicates whether an elastic IP address (EIP) is automatically created and bound to the elastic container instance.	true
ScalingGroupId	string	The ID of the scaling group.	asg-bp1frlu04fq4zv65b1bh
EphemeralStorage	integer	The size of the temporary storage space. 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 bandwidth of the EIP. Default value: 5. Unit: Mbit/s.	5
ImageSnapshotId	string	The ID of the image cache.	imc-2zebxkiifuyzzlhl****
Memory	number	The memory size. Unit: GiB. 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. If 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 when you set Scaling Policy to Cost Optimization and no instance type is specified in the scaling configuration.	4
RestartPolicy	string	The restart policy of the container group. Valid values: Never: The container group is never restarted. Always: The container group is always restarted. OnFailure: The container group is restarted upon failures.	Always
SpotPriceLimit	number	The maximum hourly price for the preemptible instance. This parameter is returned only when SpotStrategy is set to SpotWithPriceLimit.	0.025
IngressBandwidth	integer	The maximum inbound bandwidth. Unit: bit/s.	1024000
CpuOptionsThreadsPerCore	integer	The number of threads per core. You can specify this parameter 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 weight of an elastic container instance as a Server Load Balancer (SLB) backend server. Valid values: 1 to 100. Default value: 50.	50
DnsPolicy	string	The Domain Name System (DNS) policy.	Default
HostName	string	The hostname.	hostname
EgressBandwidth	integer	The maximum outbound bandwidth. Unit: bit/s.	10485760
RegionId	string	The region ID of the scaling group to which the scaling configuration belongs.	cn-shanghai
RamRoleName	string	The Resource Access Management (RAM) role of the elastic container instance. Elastic container instances and Elastic Compute Service (ECS) instances can share the same RAM role. For more information, see Use the instance RAM role by calling APIs.	ram:PassRole
Cpu	number	The number of vCPUs that are allocated to the elastic container instance.	2.0
AutoMatchImageCache	boolean	Indicates whether the image cache is automatically matched. Default value: false.	true
ResourceGroupId	string	The ID of the resource group.	rg-acfmwozpmmksakq
ContainerGroupName	string	The name of the container group.	test
ScalingConfigurationId	string	The ID of the scaling configuration.	asc-2zec39vg84usxdocme6a
CpuOptionsCore	integer	The number of physical CPU cores. You can specify this parameter for only specific instance types.	2
SlsEnable	boolean	Indicates whether user logs are collected. Default value: false.	false
Containers	array<object>	The containers in the elastic container instance.
	array<object>
ReadinessProbeHttpGetPath	string	The path to which HTTP Get requests are sent when you use the HTTP 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 requests to perform liveness probes. Valid values: HTTP HTTPS	HTTP
WorkingDir	string	The working directory in the container.	/usr/local/nginx
Tty	boolean	Specifies whether to enable the Interaction feature. Valid values: true false If the command is a /bin/bash command, the value of this parameter is true. Default value: false.	true
LivenessProbeHttpGetPort	integer	The port detected by HTTP Get requests when you use the HTTP requests to perform liveness probes.	8080
Gpu	integer	The number of GPUs.	2
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	number	The memory size.	2.0
Name	string	The container name.	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 requests to perform liveness probes.	/usr/nginx/
Image	string	The container image.	registry-vpc.aliyuncs.com/eci_open/alpine:3.5
ReadinessProbeTcpSocketPort	integer	The port detected by TCP sockets when you use the TCP sockets to perform readiness probes.	80
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.	80
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	integer	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.	5
ImagePullPolicy	string	The image pulling policy.	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	number	The number of vCPUs that are allocated to the elastic container instance.	2
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.
	object
Port	integer	The port number. Valid values: 1 to 65535.	8083
Protocol	string	The protocol type. Valid values: TCP UDP	TCP
VolumeMounts	array<object>	The volumes that are mounted to the container.
	object
ReadOnly	boolean	Indicates whether the volume is read-only. Default value: false.	true
SubPath	string	The subdirectory of the volume.	data2/
Name	string	The volume name.	default-volume1
MountPropagation	string	The mount propagation setting of the volume. 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 the 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 in which the container mounts the volume. 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.
	object
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.	fieldPath
Commands	array	The container startup commands.
	string	The container startup command.	sleep
LivenessProbeExecCommands	array	The commands that are run in the container when you use a CLI to perform liveness probes.
	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 arguments that are passed to the container startup commands.
	string	The argument that is passed to the container startup command.	100
ReadinessProbeExecCommands	array	The commands that are run in the container when you use a CLI to perform readiness probes.
	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.
	string	The permission that is granted to the process in the container. Valid values: NET_ADMIN and NET_RAW.	NET_ADMIN
LifecyclePostStartHandlerHttpGetHost	string	The IP address of the host to the HTTP GET requests for configuring the postStart callback function are sent.	10.0.XX.XX
LifecyclePostStartHandlerHttpGetPort	integer	The port over which the HTTP GET requests for configuring the postStart callback function are sent.	80
LifecyclePostStartHandlerHttpGetPath	string	The path to the HTTP GET requests for configuring the postStart callback function are sent.	/healthyz
LifecyclePostStartHandlerHttpGetScheme	string	The protocol type of the HTTP Get requests that are used for configuring the postStart callback function.	HTTP
LifecyclePostStartHandlerExecs	array	The commands that are run by using a CLI for configuring the postStart callback function within the container.
	string	The command that is run by using a CLI for configuring the postStart callback function 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 that are used for configuring the postStart callback function.	10.0.XX.XX
LifecyclePostStartHandlerTcpSocketPort	integer	The port detected by the TCP sockets that are used for configuring the postStart callback function.	80
LifecyclePreStopHandlerHttpGetHost	string	The IP address of the host to which the HTTP GET requests for configuring the preStop callback function are sent.	10.0.XX.XX
LifecyclePreStopHandlerHttpGetPort	integer	The port over which the HTTP GET requests for configuring the preStop callback function are sent.	80
LifecyclePreStopHandlerHttpGetPath	string	The path to which the HTTP GET requests for configuring the preStop callback function are sent.	/healthyz
LifecyclePreStopHandlerHttpGetScheme	string	The protocol type of the HTTP Get requests that are used for configuring the preStop callback function.	HTTP
LifecyclePreStopHandlerExecs	array	The commands that are run by using a CLI for configuring the preStop callback function within the container.
	string	The command that is run by using a CLI for configuring the preStop callback function 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 that are used for configuring the preStop callback function.	10.0.XX.XX
LifecyclePreStopHandlerTcpSocketPort	integer	The port detected by the TCP sockets that are used for configuring the preStop callback function.	80
InitContainers	array<object>	The init containers.
	array<object>
SecurityContextReadOnlyRootFilesystem	boolean	Indicates whether the root file system on which the init container runs is read-only. Valid value: true.
ImagePullPolicy	string	The image pulling policy.	Always
WorkingDir	string	The working directory of the init container.	/www
Cpu	number	The number of vCPUs that are allocated to the init container.	0.5
Image	string	The image of the init container.	registry-vpc.cn-hongkong.aliyuncs.com/eci_open/nginx:alpine
Gpu	integer	The number of GPUs that are allocated to the init container.	1
SecurityContextRunAsUser	string	The ID of the user that runs the init container.	1000
Memory	number	The memory size of the init container.	1.0
Name	string	The name of the init container.	test-init
InitContainerEnvironmentVars	array<object>	The environment variables of the init container.
	object
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.
	object
Port	integer	The port number. Valid values: 1 to 65535.	1024
Protocol	string	The protocol type. Valid values: TCP UDP	UDP
InitContainerVolumeMounts	array<object>	The volume mounts of the init container.
	object
ReadOnly	boolean	Indicates whether the mount directory is read-only. Default value: false.	false
SubPath	string	The subdirectory of the volume.	/usr/sub/
Name	string	The volume name.	test-empty
MountPropagation	string	The mount propagation setting of the volume. 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 the 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 init container mounts the volume. Note Data in this directory is overwritten by the data on the volume. Proceed with caution if you specify this parameter.	/usr/share/
SecurityContextCapabilityAdds	array	The permissions that are granted to the processes in the init container. Valid values: NET_ADMIN and NET_RAW.
	string	The permission that is 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 commands that are used to start the init container.
	string	The command that is used to start the init container.	sleep
InitContainerArgs	array	The arguments that are passed to the startup commands of the init container.
	string	The argument that is passed to the startup command of the init container.	10
Tags	array<object>	The tags of the elastic container instance. Tags are specified in the key-value format.
	object
Key	string	The tag key.	version
Value	string	The tag value.	3
Volumes	array<object>	The volumes.
	array<object>
Type	string	The volume type. Valid values: EmptyDirVolume NFSVolume ConfigFileVolume FlexVolume	EmptyDirVolume
DiskVolumeDiskId	string	The ID of the disk volume.	d-xx
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 the 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.	{"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 the configuration files.
	object
Path	string	The path to the configuration file.	/usr/bin/
Mode	integer	The permissions on the ConfigFile volume.	0644
Content	string	The content of the configuration file.	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 image repositories.
	object
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 DNS options.
	object
Name	string	The variable name of the option.	name
Value	string	The variable value of the option.	value
HostAliases	array<object>	The custom hostname mappings of a container in the elastic container instance.
	object
Ip	string	The added IP address.	192.0.XX.XX
Hostnames	array	The added hostnames.
	string	The added hostname.	['hehe.com', 'haha.com']
SecurityContextSysCtls	array<object>	The system information of the security context in which the elastic container instance is run.
	object
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 information about the Container Registry Enterprise Edition instance.
	object
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 (,).
	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 DNS servers.
	string	The IP address of the DNS server.	172.10..*
DnsConfigSearches	array	The search domains of the DNS servers.
	string	The search domain of the DNS server.	svc.local.kubenetes
NtpServers	array	The endpoints of the Network Time Protocol (NTP) servers.
	string	The endpoint of the NTP server.	ntp.cloud.aliyuncs.com
LifecycleState	string	The state of the scaling configuration in the scaling group. Valid values: Active: The scaling configuration is active in the scaling group. Auto Scaling uses the active scaling configuration to automatically create elastic container instances. Inactive: The scaling configuration is inactive in the scaling group. Inactive scaling configurations are retained in scaling groups. However, Auto Scaling does not use inactive scaling groups to create elastic container instances.	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 instance types that meet the specified criteria. 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 in a consistent manner. Instance types of this level are suitable for business 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 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.
	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 caches data.	default
DataCachePL	string	The performance level (PL) of the cloud disk that caches data. We recommend that you use enhanced 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 caches data. Valid values: 0 to min{50,000, 1,000 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 caches data. Valid values: true false Default value: false. Note For more information about ESSD AutoPL disks, see ESSD AutoPL disks.	false
EipPublicIpAddressPoolId	string	The ID of the IP address pool.	pippool-bp187arfugi543y1s****
EipCommonBandwidthPackage	string	The bound EIP bandwidth plan.	cbwp-bp1rxai1z4b1an454xl8m
EipISP	string	The line type of the EIP. Valid values: BGP: BGP (Multi-ISP) lines BGP_PRO: BGP (Multi-ISP) Pro	BGP
ComputeCategory	array	The computing power types. A value of economy indicates that economic instance types are returned.
	string	The computing power type.	economy
Output	string	The YAML output of the scaling configuration.	apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment labels: app: nginx spec: replicas: 3 selector: matchLabels: app: nginx template: metadata: labels: app: nginx annotations: k8s.aliyun.com/eip-bandwidth: 10 k8s.aliyun.com/eci-with-eip: true spec: containers: - name: nginx image: nginx:1.14.2 ports: - containerPort: 80

Examples

Success response

JSON format

{
  "RequestId": "6EF9BFEE-FE07-4627-B8FB-14326FB9****",
  "ScalingConfiguration": {
    "CreationTime": "2023-05-10T02:39:15Z",
    "ScalingConfigurationName": "scalingconfi****",
    "SecurityGroupId": "sg-bp18kz60mefs****",
    "ActiveDeadlineSeconds": 60,
    "SpotStrategy": "NoSpot",
    "AutoCreateEip": true,
    "ScalingGroupId": "asg-bp1frlu04fq4zv65b1bh",
    "EphemeralStorage": 20,
    "Ipv6AddressCount": 1,
    "Description": "This is an example.",
    "EipBandwidth": 5,
    "ImageSnapshotId": "imc-2zebxkiifuyzzlhl****",
    "Memory": 4,
    "RestartPolicy": "Always",
    "SpotPriceLimit": 0.025,
    "IngressBandwidth": 1024000,
    "CpuOptionsThreadsPerCore": 2,
    "TerminationGracePeriodSeconds": 60,
    "LoadBalancerWeight": 50,
    "DnsPolicy": "Default",
    "HostName": "hostname",
    "EgressBandwidth": 10485760,
    "RegionId": "cn-shanghai",
    "RamRoleName": "ram:PassRole\n",
    "Cpu": 2,
    "AutoMatchImageCache": true,
    "ResourceGroupId": "rg-acfmwozpmmksakq",
    "ContainerGroupName": "test",
    "ScalingConfigurationId": "asc-2zec39vg84usxdocme6a",
    "CpuOptionsCore": 2,
    "SlsEnable": false,
    "Containers": [
      {
        "ReadinessProbeHttpGetPath": "/usr/local",
        "ReadinessProbeSuccessThreshold": 1,
        "LivenessProbePeriodSeconds": 5,
        "LivenessProbeTcpSocketPort": 80,
        "LivenessProbeHttpGetScheme": "HTTP",
        "WorkingDir": "/usr/local/nginx",
        "Tty": true,
        "LivenessProbeHttpGetPort": 8080,
        "Gpu": 2,
        "ReadinessProbeInitialDelaySeconds": 5,
        "Stdin": true,
        "Memory": 2,
        "Name": "nginx",
        "SecurityContextReadOnlyRootFilesystem": true,
        "LivenessProbeHttpGetPath": "/usr/nginx/\n",
        "Image": "registry-vpc.aliyuncs.com/eci_open/alpine:3.5",
        "ReadinessProbeTcpSocketPort": 80,
        "ReadinessProbeHttpGetScheme": "HTTP",
        "ReadinessProbeHttpGetPort": 80,
        "LivenessProbeSuccessThreshold": 1,
        "ReadinessProbeTimeoutSeconds": 5,
        "SecurityContextRunAsUser": 1000,
        "LivenessProbeInitialDelaySeconds": 10,
        "ReadinessProbePeriodSeconds": 5,
        "ImagePullPolicy": "Always",
        "StdinOnce": true,
        "Cpu": 2,
        "LivenessProbeTimeoutSeconds": 10,
        "ReadinessProbeFailureThreshold": 3,
        "LivenessProbeFailureThreshold": 3,
        "Ports": [
          {
            "Port": 8083,
            "Protocol": "TCP"
          }
        ],
        "VolumeMounts": [
          {
            "ReadOnly": true,
            "SubPath": "data2/\n",
            "Name": "default-volume1",
            "MountPropagation": "None",
            "MountPath": "/pod/data"
          }
        ],
        "EnvironmentVars": [
          {
            "Key": "PATH",
            "Value": "/usr/bin/\n",
            "FieldRefFieldPath": "fieldPath"
          }
        ],
        "Commands": [
          "sleep"
        ],
        "LivenessProbeExecCommands": [
          "cat /tmp/healthy"
        ],
        "Args": [
          "100"
        ],
        "ReadinessProbeExecCommands": [
          "cat /tmp/healthy\n"
        ],
        "SecurityContextCapabilityAdds": [
          "NET_ADMIN"
        ],
        "LifecyclePostStartHandlerHttpGetHost": "10.0.XX.XX",
        "LifecyclePostStartHandlerHttpGetPort": 80,
        "LifecyclePostStartHandlerHttpGetPath": "/healthyz\n",
        "LifecyclePostStartHandlerHttpGetScheme": "HTTP",
        "LifecyclePostStartHandlerExecs": [
          "[\"/bin/sh\", \"-c\",\"echo Hello from the preStop handler > /usr/share/message\"]"
        ],
        "LifecyclePostStartHandlerTcpSocketHost": "10.0.XX.XX\n",
        "LifecyclePostStartHandlerTcpSocketPort": 80,
        "LifecyclePreStopHandlerHttpGetHost": "10.0.XX.XX\n",
        "LifecyclePreStopHandlerHttpGetPort": 80,
        "LifecyclePreStopHandlerHttpGetPath": "/healthyz",
        "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": "/www",
        "Cpu": 0.5,
        "Image": "registry-vpc.cn-hongkong.aliyuncs.com/eci_open/nginx:alpine",
        "Gpu": 1,
        "SecurityContextRunAsUser": "1000",
        "Memory": 1,
        "Name": "test-init\n",
        "InitContainerEnvironmentVars": [
          {
            "Key": "PATH",
            "Value": "/usr/local/bin\n",
            "FieldRefFieldPath": "path"
          }
        ],
        "InitContainerPorts": [
          {
            "Port": 1024,
            "Protocol": "UDP"
          }
        ],
        "InitContainerVolumeMounts": [
          {
            "ReadOnly": false,
            "SubPath": "/usr/sub/",
            "Name": "test-empty\n",
            "MountPropagation": "None",
            "MountPath": "/usr/share/\n"
          }
        ],
        "SecurityContextCapabilityAdds": [
          "NET_ADMIN"
        ],
        "InitContainerCommands": [
          "sleep"
        ],
        "InitContainerArgs": [
          "10"
        ]
      }
    ],
    "Tags": [
      {
        "Key": "version",
        "Value": "3"
      }
    ],
    "Volumes": [
      {
        "Type": "EmptyDirVolume",
        "DiskVolumeDiskId": "d-xx",
        "DiskVolumeFsType": "xfs",
        "EmptyDirVolumeMedium": "memory",
        "NFSVolumePath": "/share\n",
        "DiskVolumeDiskSize": 15,
        "NFSVolumeReadOnly": false,
        "FlexVolumeFsType": "ext4",
        "ConfigFileVolumeDefaultMode": 644,
        "FlexVolumeDriver": "flexvolume",
        "FlexVolumeOptions": "{\"volumeId\":\"d-2zehdahrwoa7srg****\",\"performanceLevel\": \"PL2\"}\n",
        "NFSVolumeServer": "3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com\n",
        "Name": "default-volume1\n",
        "ConfigFileVolumeConfigFileToPaths": [
          {
            "Path": "/usr/bin/\n",
            "Mode": 644,
            "Content": "bGl1bWk=\n"
          }
        ],
        "EmptyDirVolumeSizeLimit": "256Mi",
        "HostPathVolumeType": "Directory",
        "HostPathVolumePath": "/pod/data\n"
      }
    ],
    "ImageRegistryCredentials": [
      {
        "Password": "yourpaasword",
        "Server": "registry-vpc.cn-shanghai.aliyuncs.com\n",
        "UserName": "yourusername"
      }
    ],
    "DnsConfigOptions": [
      {
        "Name": "name",
        "Value": "value"
      }
    ],
    "HostAliases": [
      {
        "Ip": "192.0.XX.XX\n",
        "Hostnames": [
          "['hehe.com', 'haha.com']\n"
        ]
      }
    ],
    "SecurityContextSysCtls": [
      {
        "Name": "kernel.msgmax\n",
        "Value": "65536"
      }
    ],
    "AcrRegistryInfos": [
      {
        "InstanceId": "cri-nwj395hgf6f3****\n",
        "InstanceName": "acr-test\n",
        "RegionId": "cn-hangzhou\n",
        "Domains": [
          "*****-****-registry.cn-beijing.cr.aliyuncs.com\n"
        ]
      }
    ],
    "DnsConfigNameServers": [
      "172.10.*.**\n"
    ],
    "DnsConfigSearches": [
      "svc.local.kubenetes\n"
    ],
    "NtpServers": [
      "ntp.cloud.aliyuncs.com\n"
    ],
    "LifecycleState": "Active",
    "CostOptimization": false,
    "InstanceFamilyLevel": "EnterpriseLevel",
    "InstanceTypes": [
      "ecs.g6.large\n"
    ],
    "DataCacheBucket": "default",
    "DataCachePL": "PL1\n",
    "DataCacheProvisionedIops": 40000,
    "DataCacheBurstingEnabled": false,
    "EipPublicIpAddressPoolId": "pippool-bp187arfugi543y1s****",
    "EipCommonBandwidthPackage": "cbwp-bp1rxai1z4b1an454xl8m",
    "EipISP": "BGP",
    "ComputeCategory": [
      "economy"
    ]
  },
  "Output": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: nginx-deployment\n  labels:\n    app: nginx\n  spec:\n    replicas: 3\n    selector:\n       matchLabels:\n        app: nginx\n    template:\n      metadata:\n        labels:\n          app: nginx\n        annotations:\n          k8s.aliyun.com/eip-bandwidth: 10\n          k8s.aliyun.com/eci-with-eip: true\n        spec:\n          containers:\n          - name: nginx\n            image: nginx:1.14.2\n            ports:\n            - containerPort: 80"
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.