All Products
Search
Document Center

Auto Scaling:DescribeEciScalingConfigurationDetail

Last Updated:Dec 17, 2024

Queries the details of a scaling configuration. You can query a scaling configuration by its ID to learn about its details such as the temporary storage size, number of IPv6 addresses, and bandwidth of the elastic IP address (EIP). The scaling configuration details can be obtained as a YAML file.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ess:DescribeEciScalingConfigurationDetailget
*ScalingGroup
acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the scaling group to which the scaling configuration belongs.

cn-beijing
ScalingGroupIdstringNo

The ID of the scaling group to which the scaling configuration belongs.

asg-bp1ffogfdauy0jw0****
ScalingConfigurationIdstringYes

The ID of the scaling configuration based on which elastic container instances are created.

asc-bp1ffogfdauy0nu5****
OutputFormatstringNo

The output format. Set the value to YAML.

yaml

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

6EF9BFEE-FE07-4627-B8FB-14326FB9****
ScalingConfigurationobject

The information about the scaling configuration.

CreationTimestring

The time when the scaling configuration was created.

2023-05-10T02:39:15Z
ScalingConfigurationNamestring

The name of the scaling configuration.

scalingconfi****
SecurityGroupIdstring

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****
ActiveDeadlineSecondsinteger

The validity period of the scaling configuration. Unit: seconds.

60
SpotStrategystring

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
AutoCreateEipboolean

Indicates whether an elastic IP address (EIP) is automatically created and bound to the elastic container instance.

true
ScalingGroupIdstring

The ID of the scaling group.

asg-bp1frlu04fq4zv65b1bh
EphemeralStorageinteger

The size of the temporary storage space. Unit: GiB.

20
Ipv6AddressCountinteger

The number of IPv6 addresses.

1
Descriptionstring
Note This parameter is not available for use.
This is an example.
EipBandwidthinteger

The bandwidth of the EIP. Default value: 5. Unit: Mbit/s.

5
ImageSnapshotIdstring

The ID of the image cache.

imc-2zebxkiifuyzzlhl****
Memoryfloat

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
RestartPolicystring

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
SpotPriceLimitfloat

The maximum hourly price for the preemptible instance.

This parameter is returned only when SpotStrategy is set to SpotWithPriceLimit.

0.025
IngressBandwidthlong

The maximum inbound bandwidth. Unit: bit/s.

1024000
CpuOptionsThreadsPerCoreinteger

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
TerminationGracePeriodSecondsinteger

The buffer time during which a program handles operations before the program stops.

60
LoadBalancerWeightinteger

The weight of an elastic container instance as a Server Load Balancer (SLB) backend server. Valid values: 1 to 100.

Default value: 50.

50
DnsPolicystring

The Domain Name System (DNS) policy.

Default
HostNamestring

The hostname.

hostname
EgressBandwidthlong

The maximum outbound bandwidth. Unit: bit/s.

10485760
RegionIdstring

The region ID of the scaling group to which the scaling configuration belongs.

cn-shanghai
RamRoleNamestring

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
Cpufloat

The number of vCPUs that are allocated to the elastic container instance.

2.0
AutoMatchImageCacheboolean

Indicates whether the image cache is automatically matched. Default value: false.

true
ResourceGroupIdstring

The ID of the resource group.

rg-acfmwozpmmksakq
ContainerGroupNamestring

The name of the container group.

test
ScalingConfigurationIdstring

The ID of the scaling configuration.

asc-2zec39vg84usxdocme6a
CpuOptionsCoreinteger

The number of physical CPU cores. You can specify this parameter for only specific instance types.

2
SlsEnableboolean

Indicates whether user logs are collected. Default value: false.

false
Containersarray<object>

The containers in the elastic container instance.

Containerobject
ReadinessProbeHttpGetPathstring

The path to which HTTP Get requests are sent when you use the HTTP requests to perform readiness probes.

/usr/local
ReadinessProbeSuccessThresholdinteger

The minimum number of consecutive successes before a failed readiness probe is considered successful. Default value: 1. Valid value: 1.

1
LivenessProbePeriodSecondsinteger

The interval at which liveness probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.

5
LivenessProbeTcpSocketPortinteger

The port detected by TCP sockets when you use the TCP sockets to perform liveness probes.

80
LivenessProbeHttpGetSchemestring

The protocol type of HTTP GET requests when you use the HTTP requests to perform liveness probes. Valid values:

  • HTTP
  • HTTPS
HTTP
WorkingDirstring

The working directory in the container.

/usr/local/nginx
Ttyboolean

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
LivenessProbeHttpGetPortinteger

The port detected by HTTP Get requests when you use the HTTP requests to perform liveness probes.

8080
Gpuinteger

The number of GPUs.

2
ReadinessProbeInitialDelaySecondsinteger

The number of seconds that elapses from the startup of the container to the start time of a readiness probe.

5
Stdinboolean

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
Memoryfloat

The memory size.

2.0
Namestring

The container name.

nginx
SecurityContextReadOnlyRootFilesystemboolean

Indicates whether the root file system on which the container runs is read-only. Valid value: true.

true
LivenessProbeHttpGetPathstring

The path to which HTTP Get requests are sent when you use the HTTP requests to perform liveness probes.

/usr/nginx/
Imagestring

The container image.

registry-vpc.aliyuncs.com/eci_open/alpine:3.5
ReadinessProbeTcpSocketPortinteger

The port detected by TCP sockets when you use the TCP sockets to perform readiness probes.

80
ReadinessProbeHttpGetSchemestring

The protocol type of HTTP GET requests when you use the HTTP requests to perform readiness probes. Valid values:

  • HTTP
  • HTTPS
HTTP
ReadinessProbeHttpGetPortinteger

The path to which HTTP Get requests are sent when you use the HTTP Get requests to perform readiness probes.

80
LivenessProbeSuccessThresholdinteger

The minimum number of consecutive successes before a failed liveness probe is considered successful. Default value: 1. Valid value: 1.

1
ReadinessProbeTimeoutSecondsinteger

The timeout period of a readiness probe. Default value: 1. Minimum value: 1. Unit: seconds.

5
SecurityContextRunAsUserlong

The ID of the user that runs the entry point of the container process.

1000
LivenessProbeInitialDelaySecondsinteger

The number of seconds that elapses from the startup of the container to the start time of a liveness probe.

10
ReadinessProbePeriodSecondsinteger

The interval at which readiness probes are performed. Unit: seconds. Default value: 10. Minimum value: 1.

5
ImagePullPolicystring

The image pulling policy.

Always
StdinOnceboolean

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
Cpufloat

The number of vCPUs that are allocated to the elastic container instance.

2
LivenessProbeTimeoutSecondsinteger

The timeout period of a liveness probe. Default value: 1. Minimum value: 1. Unit: seconds.

10
ReadinessProbeFailureThresholdinteger

The minimum number of consecutive failures before a successful readiness probe is considered failed.

Default value: 3.

3
LivenessProbeFailureThresholdinteger

The minimum number of consecutive failures before a successful liveness probe is considered failed.

Default value: 3.

3
Portsarray<object>

The exposed ports and protocols.

Portobject
Portinteger

The port number. Valid values: 1 to 65535.

8083
Protocolstring

The protocol type. Valid values:

  • TCP
  • UDP
TCP
VolumeMountsarray<object>

The volumes that are mounted to the container.

VolumeMountobject
ReadOnlyboolean

Indicates whether the volume is read-only.

Default value: false.

true
SubPathstring

The subdirectory of the volume.

data2/
Namestring

The volume name.

default-volume1
MountPropagationstring

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
MountPathstring

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
EnvironmentVarsarray<object>

The environment variables.

EnvironmentVarobject
Keystring

The name of the environment variable.

PATH
Valuestring

The value of the environment variable.

/usr/bin/
FieldRefFieldPathstring
Note This parameter is not available for use.
fieldPath
Commandsarray

The container startup commands.

Commandstring

The container startup command.

sleep
LivenessProbeExecCommandsarray

The commands that are run in the container when you use a CLI to perform liveness probes.

LivenessProbeExecCommandstring

The command that is run in the container when you use a CLI to perform a liveness probe.

cat /tmp/healthy
Argsarray

The arguments that are passed to the container startup commands.

Argstring

The argument that is passed to the container startup command.

100
ReadinessProbeExecCommandsarray

The commands that are run in the container when you use a CLI to perform readiness probes.

ReadinessProbeExecCommandstring

The command that is run in the container when you use a CLI to perform a readiness probe.

cat /tmp/healthy
SecurityContextCapabilityAddsarray

The permissions that are granted to the processes in the container. Valid values: NET_ADMIN and NET_RAW.

InitContainerSecurityContextCapabilityAddstring

The permission that is granted to the process in the container. Valid values: NET_ADMIN and NET_RAW.

NET_ADMIN
LifecyclePostStartHandlerHttpGetHoststring

The IP address of the host to the HTTP GET requests for configuring the postStart callback function are sent.

10.0.XX.XX
LifecyclePostStartHandlerHttpGetPortinteger

The port over which the HTTP GET requests for configuring the postStart callback function are sent.

80
LifecyclePostStartHandlerHttpGetPathstring

The path to the HTTP GET requests for configuring the postStart callback function are sent.

/healthyz
LifecyclePostStartHandlerHttpGetSchemestring

The protocol type of the HTTP Get requests that are used for configuring the postStart callback function.

HTTP
LifecyclePostStartHandlerExecsarray

The commands that are run by using a CLI for configuring the postStart callback function within the container.

LifecyclePostStartHandlerExecstring

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"]
LifecyclePostStartHandlerTcpSocketHoststring

The IP address of the host detected by the TCP sockets that are used for configuring the postStart callback function.

10.0.XX.XX
LifecyclePostStartHandlerTcpSocketPortinteger

The port detected by the TCP sockets that are used for configuring the postStart callback function.

80
LifecyclePreStopHandlerHttpGetHoststring

The IP address of the host to which the HTTP GET requests for configuring the preStop callback function are sent.

10.0.XX.XX
LifecyclePreStopHandlerHttpGetPortinteger

The port over which the HTTP GET requests for configuring the preStop callback function are sent.

80
LifecyclePreStopHandlerHttpGetPathstring

The path to which the HTTP GET requests for configuring the preStop callback function are sent.

/healthyz
LifecyclePreStopHandlerHttpGetSchemestring

The protocol type of the HTTP Get requests that are used for configuring the preStop callback function.

HTTP
LifecyclePreStopHandlerExecsarray

The commands that are run by using a CLI for configuring the preStop callback function within the container.

LifecyclePreStopHandlerExecstring

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"]
LifecyclePreStopHandlerTcpSocketHoststring

The IP address of the host detected by the TCP sockets that are used for configuring the preStop callback function.

10.0.XX.XX
LifecyclePreStopHandlerTcpSocketPortinteger

The port detected by the TCP sockets that are used for configuring the preStop callback function.

80
InitContainersarray<object>

The init containers.

InitContainerobject
SecurityContextReadOnlyRootFilesystemboolean

Indicates whether the root file system on which the init container runs is read-only. Valid value: true.

ImagePullPolicystring

The image pulling policy.

Always
WorkingDirstring

The working directory of the init container.

/www
Cpufloat

The number of vCPUs that are allocated to the init container.

0.5
Imagestring

The image of the init container.

registry-vpc.cn-hongkong.aliyuncs.com/eci_open/nginx:alpine
Gpuinteger

The number of GPUs that are allocated to the init container.

1
SecurityContextRunAsUserstring

The ID of the user that runs the init container.

1000
Memoryfloat

The memory size of the init container.

1.0
Namestring

The name of the init container.

test-init
InitContainerEnvironmentVarsarray<object>

The environment variables of the init container.

InitContainerEnvironmentVarobject
Keystring

The name of the environment variable.

PATH
Valuestring

The value of the environment variable.

/usr/local/bin
FieldRefFieldPathstring
Note This parameter is not available for use.
path
InitContainerPortsarray<object>

The ports of the init container.

InitContainerPortobject
Portinteger

The port number. Valid values: 1 to 65535.

1024
Protocolstring

The protocol type. Valid values:

  • TCP
  • UDP
UDP
InitContainerVolumeMountsarray<object>

The volume mounts of the init container.

InitContainerVolumeMountobject
ReadOnlyboolean

Indicates whether the mount directory is read-only.

Default value: false.

false
SubPathstring

The subdirectory of the volume.

/usr/sub/
Namestring

The volume name.

test-empty
MountPropagationstring

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
MountPathstring

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/
SecurityContextCapabilityAddsarray

The permissions that are granted to the processes in the init container. Valid values: NET_ADMIN and NET_RAW.

InitContainerSecurityContextCapabilityAddstring

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
InitContainerCommandsarray

The commands that are used to start the init container.

InitContainerCommandstring

The command that is used to start the init container.

sleep
InitContainerArgsarray

The arguments that are passed to the startup commands of the init container.

InitContainerArgstring

The argument that is passed to the startup command of the init container.

10
Tagsarray<object>

The tags of the elastic container instance. Tags are specified in the key-value format.

Tagobject
Keystring

The tag key.

version
Valuestring

The tag value.

3
Volumesarray<object>

The volumes.

Volumeobject
Typestring

The volume type. Valid values:

  • EmptyDirVolume
  • NFSVolume
  • ConfigFileVolume
  • FlexVolume
EmptyDirVolume
DiskVolumeDiskIdstring

The ID of the disk volume.

d-xx
DiskVolumeFsTypestring

The system type of the disk volume.

xfs
EmptyDirVolumeMediumstring

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
NFSVolumePathstring

The path to the Network File System (NFS) volume.

/share
DiskVolumeDiskSizeinteger

The size of the disk volume. Unit: GiB.

15
NFSVolumeReadOnlyboolean

Indicates whether the NFS volume is read-only.

Default value: false.

false
FlexVolumeFsTypestring

The type of the mounted file system. The default value is determined by the script of FlexVolume.

ext4
ConfigFileVolumeDefaultModeinteger

The default permissions on the ConfigFile volume.

0644
FlexVolumeDriverstring

The name of the FlexVolume driver.

flexvolume
FlexVolumeOptionsstring

The FlexVolume options.

{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}
NFSVolumeServerstring

The endpoint of the NFS server.

3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com
Namestring

The volume name.

default-volume1
ConfigFileVolumeConfigFileToPathsarray<object>

The paths to the configuration files.

ConfigFileVolumeConfigFileToPathobject
Pathstring

The path to the configuration file.

/usr/bin/
Modeinteger

The permissions on the ConfigFile volume.

0644
Contentstring

The content of the configuration file.

bGl1bWk=
EmptyDirVolumeSizeLimitstring

The storage size of the emptyDir volume.

256Mi
HostPathVolumeTypestring

The type of the HostPath volume.

Directory
HostPathVolumePathstring

The path to the HostPath volume on the host.

/pod/data
ImageRegistryCredentialsarray<object>

The image repositories.

ImageRegistryCredentialobject
Passwordstring

The password of the image repository.

yourpaasword
Serverstring

The domain name of the image repository.

registry-vpc.cn-shanghai.aliyuncs.com
UserNamestring

The username of the image repository.

yourusername
DnsConfigOptionsarray<object>

The DNS options.

DnsConfigOptionobject
Namestring

The variable name of the option.

name
Valuestring

The variable value of the option.

value
HostAliasesarray<object>

The custom hostname mappings of a container in the elastic container instance.

HostAliasobject
Ipstring

The added IP address.

192.0.XX.XX
Hostnamesarray

The added hostnames.

Hostnamestring

The added hostname.

['hehe.com', 'haha.com']
SecurityContextSysCtlsarray<object>

The system information of the security context in which the elastic container instance is run.

SecurityContextSysCtlobject
Namestring

The system name of the security context in which the elastic container instance runs.

kernel.msgmax
Valuestring

The variable value of the security context in which the elastic container instance runs.

65536
AcrRegistryInfosarray<object>

The information about the Container Registry Enterprise Edition instance.

AcrRegistryInfoobject
InstanceIdstring

The ID of the Container Registry Enterprise Edition instance.

cri-nwj395hgf6f3****
InstanceNamestring

The name of the Container Registry Enterprise Edition instance.

acr-test
RegionIdstring

The region ID of the Container Registry Enterprise Edition instance.

cn-hangzhou
Domainsarray

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 (,).

Domainstring

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
DnsConfigNameServersarray

The IP addresses of DNS servers.

DnsConfigNameServerstring

The IP address of the DNS server.

172.10.*.**
DnsConfigSearchesarray

The search domains of the DNS servers.

DnsConfigSearchestring

The search domain of the DNS server.

svc.local.kubenetes
NtpServersarray

The endpoints of the Network Time Protocol (NTP) servers.

NtpServerstring

The endpoint of the NTP server.

ntp.cloud.aliyuncs.com
LifecycleStatestring

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
CostOptimizationboolean

Indicates whether the Cost Optimization feature is enabled. Valid values:

  • true
  • false
false
InstanceFamilyLevelstring

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
InstanceTypesarray

The specified ECS instance types. You can specify up to five instance types.

InstanceTypestring

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
DataCacheBucketstring

The bucket that caches data.

default
DataCachePLstring

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
DataCacheProvisionedIopsinteger

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
DataCacheBurstingEnabledboolean

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
EipPublicIpAddressPoolIdstring

The ID of the IP address pool.

pippool-bp187arfugi543y1s****
EipCommonBandwidthPackagestring

The bound EIP bandwidth plan.

cbwp-bp1rxai1z4b1an454xl8m
EipISPstring

The line type of the EIP. Valid values:

  • BGP: BGP (Multi-ISP) lines
  • BGP_PRO: BGP (Multi-ISP) Pro
BGP
ComputeCategoryarray

The computing power types. A value of economy indicates that economic instance types are returned.

ComputeCategorystring

The computing power type.

economy
Outputstring

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

Sample success responses

JSONformat

{
  "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 codeError codeError message
403Forbidden.RiskControlForbidden.RiskControl

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

Change history

Change timeSummary of changesOperation
No change history