# Alibaba Cloud Auto Scaling API > Alibaba Cloud Auto Scaling API on Apizie: 90 endpoints (Creates and manages Elastic Container Instance (ECI)-based scaling groups by using a configuration file. You…, Adds one or more Application Load Balancer (ALB) server groups to a scaling group, Adds one or more ApsaraDB RDS instances to a scaling group, Manually adds ECS instances to a scaling group, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-ess/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-ess` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/ess - Page: https://zieapi.vercel.app/api/cloud/aliyun-ess - OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-ess/openapi.json Alibaba Cloud OpenAPI for Auto Scaling (ess, version 2014-08-28). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Creates and manages Elastic Container Instance (ECI)-based scaling groups by using a configuration file. You… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/apply-scaling-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | Content | string | yes | The content of the configuration file | | RegionId | string | no | The region ID | | Format | string | no | The Format | ### Adds one or more Application Load Balancer (ALB) server groups to a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/attach-alb-server-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region to which the scaling group belongs. Examples: `cn-hangzhou` and `cn-shanghai`. For more information, see… | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | ForceAttach | string | no | Specifies whether to add the ECS instances or elastic container instances in the scaling group to the newly added ALB server groups. Valid… | | AlbServerGroup | string | yes | The ALB server groups (JSON-encoded) | ### Adds one or more ApsaraDB RDS instances to a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/attach-dbinstances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ForceAttach | string | no | Specifies whether to add the private IP addresses of all instances in the current scaling group to the IP address whitelist of the… | | ClientToken | string | no | Ensures the idempotence of the request. You can generate the value on your client to ensure that the value is unique across different… | | DBInstance | string | yes | The ID of ApsaraDB RDS instance N. Valid values of N: 1 to 5 (JSON-encoded) | | RegionId | string | no | The region ID of the scaling group | | AttachMode | string | no | The association mode between the scaling group and the database. Valid values: SecurityIp: IP address whitelist mode. The scaling group is… | | Type | string | no | The database type. Valid values: RDS Redis MongoDB Default value: RDS | ### Manually adds ECS instances to a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/attach-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | Entrusted | string | no | Specifies whether to entrust the lifecycle of an existing instance to the scaling group when the instance is manually added to the scaling… | | InstanceId | string | no | InstanceId.N specifies instance ID of the ECS instance, ECI instance, managed instance, or stopped instance in the scaling group to be… | | LoadBalancerWeight | string | no | The weight of the ECS instance or ECI instance as a load balancing backend server. Settings for this parameter are not supported for… | | LifecycleHook | string | no | Specifies whether to trigger the scale-out lifecycle hook when instances are added to the scaling group. Valid values: true: Triggered.… | | RegionId | string | no | The region ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client to ensure that the… | | IgnoreInvalidInstance | string | no | Specifies whether to ignore invalid instances when a batch of instances is added to the scaling group. Valid values: true: Invalid… | ### Adds one or more load balancing instances `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/attach-load-balancers` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ForceAttach | string | no | Specifies whether to add all instances in the current scaling group as backend servers of the load balancing CLB (formerly SLB) instances.… | | ClientToken | string | no | Ensures the idempotence of the request. You can generate the parameter value on your client to ensure that the value is unique across… | | Async | string | no | Specifies whether to use asynchronous invocation when you add load balancing CLB (formerly SLB) instances. Asynchronous invocation ensures… | | LoadBalancer | string | no | The IDs of the load balancing CLB (formerly SLB) instances to be added. Valid values of N: 1 to 5 (JSON-encoded) | | LoadBalancerConfig | string | no | The configurations of the load balancing CLB (formerly SLB) instances (JSON-encoded) | ### Adds one or more load balancing server groups to a scaling group. Supported server group types include… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/attach-server-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | Ensures the idempotence of the request. The client generates a parameter value to ensure that the value is unique across different… | | ForceAttach | string | no | Specifies whether to add the ECS instances or ECI instances in the current scaling group to the newly added server groups. Valid values:… | | ServerGroup | string | yes | The details of the load balancing server groups (JSON-encoded) | ### Adds one or more virtual server groups to a load balancing instance associated with a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/attach-vserver-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the scaling group resides, such as cn-hangzhou or cn-shanghai. For more information, see… | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | ForceAttach | string | no | Specifies whether to add the existing ECS instances or elastic container instances in the scaling group to the new virtual server groups.… | | VServerGroup | string | yes | The information about the virtual server groups associated with the scaling group (JSON-encoded) | ### Cancels an instance refresh task. Instances that have already been replaced or added during scale-out are… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/cancel-instance-refresh` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ScalingGroupId | string | yes | The ID of the scaling group | | InstanceRefreshTaskId | string | no | The ID of the instance refresh task | ### Changes the resource group of a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/change-resource-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region to which the scaling group belongs | | ResourceType | string | no | The resource type. Only scaling groups are supported. Valid values: scalinggroup | | ResourceId | string | yes | The ID of the scaling group whose resource group you want to change | | NewResourceGroupId | string | yes | The ID of the new resource group to which the scaling group is moved | ### Ends the wait state of a scaling activity in advance `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/complete-lifecycle-action` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | LifecycleHookId | string | yes | The ID of the lifecycle hook | | LifecycleActionToken | string | yes | The identifier of the wait state of the scaling activity. You can obtain this value from the Message Service (MNS) queue or MNS topic… | | LifecycleActionResult | string | no | The next action after the wait state of the lifecycle hook ends. Valid values: CONTINUE: Continues to respond to the scale-out activity… | | ClientToken | string | no | Ensures the idempotence of the request. You can generate a parameter value on your client to ensure that the value is unique across… | | RegionId | string | no | The ID of the region to which the scaling group belongs | ### Creates an event-triggered task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-alarm` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | Name | string | no | The name of the event-triggered task | | Description | string | no | The description of the event-triggered task | | ScalingGroupId | string | yes | The ID of the scaling group associated with the event-triggered task | | MetricName | string | no | The name of the monitoring metric. Valid values vary based on the monitoring type of the event-triggered task: If the event-triggered task… | | MetricType | string | no | The type of the monitoring metric. Valid values: system: uses CloudMonitor system metrics. custom: uses custom metrics reported to… | | Period | integer | no | The statistical period for the monitoring metric data. Unit: seconds. Valid values: 15 60 120 300 900 Only scaling groups of the ECS type… | | Statistics | string | no | The method used to aggregate the monitoring metric data. Valid values: Average: average value. Minimum: minimum value. Maximum: maximum… | | Threshold | number | no | The threshold of the monitoring metrics. An alert is triggered and the scaling rule is executed when the threshold expression is met for… | | ComparisonOperator | string | no | The comparison operator between the aggregated value of the monitoring metric and the threshold. This parameter specifies the relationship… | | EvaluationCount | integer | no | The number of consecutive times that the threshold expression must be met before the scaling rule is executed. For example, the average… | | GroupId | integer | no | The ID of the CloudMonitor application group to which the custom monitoring metric belongs. This parameter is required only when… | | Effective | string | no | The effective period of the event-triggered task. By default, the event-triggered task is effective at all times. This parameter follows… | | AlarmAction | string | no | The unique identifier of the scaling rule associated with the event-triggered task (JSON-encoded) | | Dimension | string | no | The list of dimensions associated with the monitoring metric (JSON-encoded) | | Expression | string | no | The information about multi-metric alert rules (JSON-encoded) | | ExpressionsLogicOperator | string | no | The relationship between multiple metric alert conditions. Valid values: `&&`: an alert is triggered only when all monitoring metrics meet… | ### Creates an ECI scaling configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-eci-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group to which the scaling configuration belongs | | ScalingConfigurationName | string | no | The name of the scaling configuration. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (_),… | | SecurityGroupId | string | no | The ID of the security group to which the ECI instance belongs. ECI instances in the same security group can access each other. If you do… | | ContainerGroupName | string | no | The name of the ECI, which is the name of the container group. To set a sequential name, use the following format:… | | RestartPolicy | string | no | The restart policy of the ECI. Valid values: Always: Always restarts the ECI. Never: Never restarts the ECI. OnFailure: Restarts the ECI… | | Cpu | number | no | The number of vCPUs of the instance. Unit: cores | | Memory | number | no | The memory size of the instance. Unit: GiB | | ResourceGroupId | string | no | The ID of the resource group | | DnsPolicy | string | no | The DNS policy. Valid values: None: Uses the DNS settings specified in the DnsConfig field. Default: Inherits the DNS settings of the… | | ImageSnapshotId | string | no | The ID of the image cache | | RamRoleName | string | no | The name of the instance RAM role. ECIs and ECS instances share the same instance RAM roles. For more information, see… | | TerminationGracePeriodSeconds | integer | no | The buffer time for the program to handle operations before shutdown. Unit: seconds | | AutoMatchImageCache | string | no | Specifies whether to automatically match an image cache. Valid values: true: Yes. false: No. Default value: false | | Ipv6AddressCount | integer | no | The number of IPv6 addresses | | ActiveDeadlineSeconds | integer | no | The validity period. Unit: seconds | | SpotStrategy | string | no | The preemption policy for the instance. Valid values: NoSpot: regular pay-as-you-go instances SpotWithPriceLimit: spot instances with a… | | SpotPriceLimit | number | no | The maximum hourly price of the spot instance. The value is accurate to three decimal places. If SpotStrategy is set to… | | AutoCreateEip | string | no | Specifies whether automatic creation of an elastic IP address (EIP) is enabled and the system will attach it to the ECI instance | | EipBandwidth | integer | no | The bandwidth of the EIP. Default value: 5 Mbit/s | | HostName | string | no | The hostname, which is the name of the container group | | IngressBandwidth | integer | no | The inbound bandwidth limit. Unit: bytes | | EgressBandwidth | integer | no | The outbound bandwidth limit. Unit: bytes | | CpuOptionsCore | integer | no | The number of physical CPU cores. Only specific instance types support custom settings. For more information, see… | | CpuOptionsThreadsPerCore | integer | no | The number of threads per core. Only specific instance types support custom settings. A value of 1 indicates that hyper-threading is… | | EphemeralStorage | integer | no | The size of the ephemeral storage. By default, PL1 ESSD cloud disks are used. Unit: GiB | | LoadBalancerWeight | integer | no | The weight of the ECI instance when it serves as a backend server for load balancing. Valid values: 1 to 100. Default value: 50 | | Tag | string | no | The tags of the instance (JSON-encoded) | | ImageRegistryCredential | string | no | The information about the image registry (JSON-encoded) | | Container | string | no | The container information included in the instance (JSON-encoded) | | Volume | string | no | The volume information (JSON-encoded) | | InitContainer | string | no | The list of init containers (JSON-encoded) | | DnsConfigNameServer | string | no | The list of IP addresses of DNS servers (JSON-encoded) | | DnsConfigSearch | string | no | The list of DNS search domains (JSON-encoded) | | DnsConfigOption | string | no | The list of object options. Each object consists of a Name and an optional Value (JSON-encoded) | | HostAliase | string | no | The custom hostname mapping for a container in the instance (JSON-encoded) | | SecurityContextSysctl | string | no | The system information (JSON-encoded) | | NtpServer | string | no | The NTP server (JSON-encoded) | | AcrRegistryInfo | string | no | The information about the ACR Enterprise instance (JSON-encoded) | | CostOptimization | string | no | Specifies whether to enable cost optimization. Valid values: true: enabled. false: disabled. Default value: false | | InstanceFamilyLevel | string | no | The instance family level, which is used to filter the instance types that meet the requirements. This parameter takes effect only when… | | InstanceType | string | no | The specified ECS instance types. You can specify up to five instance types (JSON-encoded) | | DataCacheBucket | string | no | The data cache bucket | | DataCachePL | string | no | The performance level of the cloud disk used for data caching. ESSD cloud disks are recommended. Valid values for the performance level of… | | DataCacheProvisionedIops | integer | no | The provisioned read/write IOPS of the ESSD AutoPL disk used for data caching. Valid values: 0 to min{50000, 1000 × Capacity - Baseline… | | DataCacheBurstingEnabled | string | no | Specifies whether to enable the burstable performance feature for the ESSD AutoPL disk used for data caching. Valid values: true: Enabled.… | | GpuDriverVersion | string | no | Specifies the GPU driver version. Valid values: tesla=470.82.01 (default) tesla=525.85.12 Only specific instance types support switching… | ### Creates one or more lifecycle hooks for a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-lifecycle-hook` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | LifecycleHookName | string | no | The name of the lifecycle hook. The name must be unique within the current scaling group. It must be 2 to 64 characters in length and… | | LifecycleTransition | string | yes | The type of scaling activity to which the lifecycle hook applies. Valid values: SCALE_OUT: scale-out activities of the scaling group.… | | DefaultResult | string | no | The action to be performed after the wait state ends. Valid values: CONTINUE: continues to respond to the scale-out or scale-in activity.… | | HeartbeatTimeout | integer | no | The wait time set by the lifecycle hook for the scaling activity. After the wait state times out, the next action is performed. Valid… | | NotificationMetadata | string | no | The notification message pushed to the `NotificationArn` (Notification Recipient) when the lifecycle hook pauses the scaling activity.… | | NotificationArn | string | no | The identifier of the notification recipient for the lifecycle hook. If this parameter is not specified, no notification is sent. If this… | ### Event notifications support automatically sending messages to the CloudMonitor monitoring service, MNS… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-notification-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | NotificationArn | string | yes | The identity of the Notification Recipient. The Settings for this parameter support the following notification methods: CloudMonitor… | | NotificationType | string | yes | The types of Auto Scaling events and resource changes that trigger notifications. Valid values of N: 1 to 8. Specify multiple values in a… | | RegionId | string | no | The region ID of the scaling group | | TimeZone | string | no | The time zone for notifications. Specify the time zone offset from Coordinated Universal Time (UTC), such as UTC+8 or UTC-7 | | MessageEncoding | string | no | The encoding method for the notification content. Valid values: PlainText: no encoding. The content is transmitted in plaintext. Base64:… | ### Creates an ECS-type scaling configuration for a scaling group by calling the CreateScalingConfiguration… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group to which the scaling configuration belongs | | ImageId | string | no | The ID of the image file. The image is used for automatic creation of ECS instances. This parameter has the same effect as the `ImageName`… | | ImageName | string | no | The name of the image file. Image names are unique within a region. You cannot use this parameter to specify images from Alibaba Cloud… | | InstanceType | string | no | The instance type of the ECS instance. For more information, see https://help.aliyun.com/document_detail/25378.html. The four methods… | | Cpu | integer | no | The number of vCPUs. Unit: cores. You can specify both Cpu and Memory to define the range of instance types. For example, you can set Cpu… | | Memory | integer | no | The memory size. Unit: GiB. You can specify both Cpu and Memory to define the range of instance types. For example, you can set Cpu to 2… | | DeploymentSetId | string | no | The ID of the deployment set to which the ECS instance belongs | | SecurityGroupId | string | no | The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other | | IoOptimized | string | no | Specifies whether the instance is an I/O optimized instance. Valid values: none: The instance is not an I/O optimized instance. optimized:… | | InternetChargeType | string | no | The billing method for network usage. Valid values: PayByBandwidth: pay-by-bandwidth. The value of InternetMaxBandwidthOut is used as the… | | InternetMaxBandwidthIn | integer | no | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: If the maximum outbound public bandwidth is less than or equal to 10… | | InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0 | | SystemDisk.Category | string | no | The category of the system cloud disk. Valid values: cloud: basic cloud disk. cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD.… | | SystemDisk.Size | integer | no | The size of the system cloud disk. Unit: GiB. Valid values: Basic cloud disk: 20 to 500. ESSD: - PL0: 1 to 2048. - PL1: 20 to 2048. - PL2:… | | SystemDisk.DiskName | string | no | The name of the system cloud disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores… | | SystemDisk.Description | string | no | The description of the system cloud disk. The description must be 2 to 256 characters in length and cannot start with `http://` or… | | SystemDisk.AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy that is applied to the system cloud disk | | SystemDisk.PerformanceLevel | string | no | Settings for the performance level (PL) of the system cloud disk when the disk is a standard SSD. Valid values: PL0: A single ESSD can… | | ScalingConfigurationName | string | no | The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_),… | | LoadBalancerWeight | integer | no | The weight of the ECS instance as a backend server of the associated load balancing instance. Valid values: 1 to 100. Default value: 50 | | Tags | string | no | The tags of the ECS instance. Tags are specified as key-value pairs. You can specify up to 20 tags. The following limits apply to tag keys… | | UserData | string | no | The user data of the ECS instance. The data must be encoded in Base64. The maximum size of the raw data before encoding is 32 KB | | KeyPairName | string | no | The name of the key pair used to log on to the ECS instance. For Windows instances, this parameter is ignored and is empty by default. For… | | RamRoleName | string | no | The name of the RAM role associated with the ECS instance. The name is provided and maintained by RAM. You can call… | | SecurityEnhancementStrategy | string | no | Specifies whether to enable security hardening. Valid values: Active: Security hardening is enabled. This value is applicable only to… | | InstanceName | string | no | The name of the ECS instance that is created through automatic creation by using the scaling configuration | | HostName | string | no | The hostname of the ECS instance. A period (.) or a hyphen (-) cannot be used as the first or last character, or used consecutively.… | | SpotStrategy | string | no | The preemption policy for pay-as-you-go instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot… | | PasswordInherit | string | no | Specifies whether to use the password preset in the image. To use this parameter, make sure that a password is configured for the image.… | | Password | string | no | The password of the ECS instance. The password must be 8 to 30 characters in length and must contain at least three of the following… | | ResourceGroupId | string | no | The ID of the resource group to which the ECS instance belongs | | HpcClusterId | string | no | The ID of the HPC cluster to which the ECS instance belongs | | InstanceDescription | string | no | The description of the ECS instance. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… | | Ipv6AddressCount | integer | no | The number of randomly generated IPv6 addresses allocated to the network interface controller (NIC) | | CreditSpecification | string | no | The running pattern of the burstable instance. Valid values: Standard: standard pattern. Unlimited: unlimited pattern. For more… | | ImageFamily | string | no | The name of the image family. You can set this parameter to obtain the latest available image from the specified image family for instance… | | ZoneId | string | no | The zone ID of the ECS instance | | DedicatedHostId | string | no | Specifies whether to create the ECS instance on a dedicated host. Because dedicated hosts do not support the creation of spot instances,… | | Affinity | string | no | Specifies whether the instance on a dedicated host is associated with the dedicated host. Valid values: default: The instance is not… | | Tenancy | string | no | Specifies whether to create the instance on a dedicated host. Valid values: default: The instance is not created on a dedicated host.… | | SchedulerOptions | string | no | The scheduler options (JSON-encoded) | | PrivatePoolOptions.MatchCriteria | string | no | The private pool option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is… | | PrivatePoolOptions.Id | string | no | The private pool ID, which is the ID of the elasticity assurance or capacity reservation | | SpotDuration | integer | no | The retention period of the spot instance. Unit: hours. Valid values: 1: After the instance is created, Alibaba Cloud ensures that the… | | SpotInterruptionBehavior | string | no | The interruption pattern of the spot instance. Only Terminate (default) is supported, which directly releases the instance | | InstanceTypes | string | no | The instance types (JSON-encoded) | | InstanceTypeOverride | string | no | The instance type information (JSON-encoded) | | DataDisk | string | no | The data cloud disk information (JSON-encoded) | | SpotPriceLimit | string | no | The spot instance information (JSON-encoded) | | SecurityGroupIds | string | no | The IDs of the security groups to which the ECS instance is added. The valid values of N depend on the maximum number of security groups… | | InstancePatternInfo | string | no | The instance type-related information in intelligent mode (JSON-encoded) | | SystemDiskCategories | string | no | The disk types of the system cloud disk. Valid values of N: 1 to 4. You can specify up to four disk types for the system cloud disk in a… | | SystemDisk.Encrypted | string | no | Specifies whether to encrypt the system cloud disk. Valid values: true: encrypts the system cloud disk. false: does not encrypt the system… | | SystemDisk.KMSKeyId | string | no | The ID of the Key Management Service (KMS) key used for the system cloud disk | | SystemDisk.EncryptAlgorithm | string | no | The encryption algorithm used for the system cloud disk. Valid values: AES-256. SM4-128. Default value: AES-256 | | SystemDisk.ProvisionedIops | integer | no | The provisioned IOPS (Input/Output Operations Per Second) performance metrics of the system cloud disk. IOPS (Input/Output Operations Per… | | SystemDisk.BurstingEnabled | string | no | Specifies whether to enable the burst (performance burst) feature for the system cloud disk. Valid values: true: enables the feature.… | | ImageOptions.LoginAsNonRoot | string | no | Specifies whether the ECS instance uses the `ecs-user` user for logon. For more information, see… | | DeletionProtection | string | no | The release protection property of the ECS instance. This property applies only to pay-as-you-go instances and specifies whether the… | | StorageSetId | string | no | The ID of the storage set | | StorageSetPartitionNumber | integer | no | The maximum number of partitions in the storage set. Valid values: integers that are greater than or equal to 2 | | CustomPriorities | string | no | The custom priorities of ECS instance type + vSwitch combinations. This parameter takes effect only when the `scaling policy` of the… | | NetworkInterfaces | string | no | The list of elastic network interfaces (ENIs) (JSON-encoded) | | DedicatedHostClusterId | string | no | The ID of the dedicated host cluster | | SecurityOptions | string | no | The security options (JSON-encoded) | | HttpEndpoint | string | no | Specifies whether to enable the access channel for instance metadata. Valid values: enabled: enables the access channel. disabled:… | | HttpTokens | string | no | Specifies whether to forcefully use the security-enhanced mode (IMDSv2) to access instance metadata. Valid values: optional: does not… | | ResourcePoolOptions | string | no | The resource pool policy used when creating instances. After you set this parameter, note the following items: This parameter takes effect… | | SecondaryEniVSwitchConstraint | string | no | Specifies whether a vSwitch must be selected from the VSwitchIds list for the secondary elastic network interfaces (ENIs) when the… | ### Creates a scaling group to automatically adjust your compute capacity (the number of instances) based on… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-scaling-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupName | string | no | The name of the scaling group. The name must be unique within a region. The name must be 2 to 64 characters in length and can contain… | | LaunchTemplateId | string | no | The ID of the launch template from which the scaling group obtains launch configuration information | | LaunchTemplateVersion | string | no | The version of the launch template. Valid values: A fixed template version number. Default: always uses the default template version.… | | InstanceId | string | no | The instance ID. When you create a scaling group, the required configuration information is obtained from the specified instance, and a… | | RegionId | string | yes | The region ID of the scaling group. For more information, see https://help.aliyun.com/document_detail/40654.html | | MinSize | integer | yes | The minimum number of instances in the scaling group. When the number of instances in the scaling group is less than the value of… | | MaxSize | integer | yes | The maximum number of instances in the scaling group. When the number of instances in the scaling group is greater than the value of… | | DefaultCooldown | integer | no | The cooldown time after a scaling activity (adding or removing instances) is complete. Valid values: 0 to 86400. Unit: seconds. During the… | | LoadBalancerIds | string | no | The IDs of CLB (formerly SLB) instances. The value can be a JSON array that consists of multiple CLB instance IDs. Separate the IDs with… | | DBInstanceIds | string | no | The IDs of ApsaraDB RDS instances. The value can be a JSON array that consists of multiple ApsaraDB RDS instance IDs. Separate the IDs… | | RemovalPolicy.1 | string | no | The first-round filter strategy for the scale-in policy. This parameter cannot have the same value as RemovalPolicy.2 or RemovalPolicy.3.… | | RemovalPolicy.2 | string | no | The second-round filter strategy for the scale-in policy. This parameter cannot have the same value as RemovalPolicy.1 or RemovalPolicy.3.… | | RemovalPolicy.3 | string | no | The third-round filter strategy for the scale-in policy. This parameter cannot have the same value as RemovalPolicy.1 or RemovalPolicy.2.… | | VSwitchId | string | no | The ID of the vSwitch. If you specify this parameter, the network type of the scaling group is VPC. If neither VSwitchId nor VSwitchIds.N… | | MultiAZPolicy | string | no | The scaling policy for ECS instances in a multi-zone scaling group. Valid values: PRIORITY: the vSwitch specified first (VSwitchIds.N) has… | | HealthCheckType | string | no | The health check mode of the scaling group. Valid values: NONE: no health check is performed. ECS: health checks are performed on… | | ScalingPolicy | string | no | The reclaim mode of the scaling group. Valid values: recycle: the scaling group uses the shutdown and reclaim mode. release: the scaling… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value from your client that is unique among different… | | OnDemandBaseCapacity | integer | no | The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. When the number of pay-as-you-go… | | OnDemandPercentageAboveBaseCapacity | integer | no | The percentage of pay-as-you-go instances among the excess instances after the minimum number of pay-as-you-go instances… | | SpotInstanceRemedy | string | no | Specifies whether to supplement spot instances. If this feature is enabled, Auto Scaling attempts to create a new instance to replace a… | | CompensateWithOnDemand | string | no | Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances when spot instances cannot… | | SpotInstancePools | integer | no | The number of available instance types. Auto Scaling evenly creates spot instances of multiple types that offer the lowest cost. Valid… | | DesiredCapacity | integer | no | The expected number of instances in the scaling group. The scaling group automatically maintains the number of ECS instances at the… | | GroupDeletionProtection | string | no | Specifies whether to enable deletion protection for the scaling group. Valid values: true: enables deletion protection. The scaling group… | | GroupType | string | no | The type of instances managed by the scaling group. Valid values: ECS: the scaling group manages ECS instances. ECI: the scaling group… | | ContainerGroupId | string | no | The instance ID of the ECI instance, which is the container group ID | | VSwitchIds | string | no | The IDs of one or more vSwitches. If you specify the VSwitchIds parameter, the VSwitchId parameter is ignored. If you specify this… | | LifecycleHook | string | no | The lifecycle hook information (JSON-encoded) | | VServerGroup | string | no | The information about the virtual service groups associated with the scaling group (JSON-encoded) | | Tag | string | no | The tags of the scaling group (JSON-encoded) | | LaunchTemplateOverride | string | no | The launch template override information (JSON-encoded) | | AlbServerGroup | string | no | The information about ALB server groups (JSON-encoded) | | ServerGroup | string | no | The information about load balancing server groups. You cannot set the same server group information in both `AlbServerGroups` and… | | AzBalance | string | no | Specifies whether to evenly distribute the capacity of the scaling group across multiple zones. This parameter takes effect only when… | | AllocationStrategy | string | no | The capacity allocation strategy that determines how the scaling group selects available instance types to meet capacity requirements. The… | | SpotAllocationStrategy | string | no | The allocation strategy for spot capacity. You can use this parameter to separately specify the allocation strategy for spot capacity.… | | MaxInstanceLifetime | integer | no | The maximum amount of time that an instance can exist in the scaling group. Unit: seconds. Valid values: `[86400, Integer.maxValue]`.… | | CustomPolicyARN | string | no | The Alibaba Cloud Resource Name (ARN) of the China custom scale-in policy function. This parameter takes effect only when the first… | | ResourceGroupId | string | no | The ID of the resource group to which the scaling group belongs. The newly created scaling group is added to the specified resource group.… | | LoadBalancerConfig | string | no | The configurations of Classic Load Balancer (CLB, formerly SLB) instances (JSON-encoded) | | HealthCheckTypes | string | no | The health check modes of the scaling group. You can use this parameter to specify multiple health check modes. If the `HealthCheckType`… | | DBInstance | string | no | The databases associated with the scaling group (JSON-encoded) | | StopInstanceTimeout | integer | no | The timeout period for waiting for an ECS instance to stop during a scale-in process. Unit: seconds. Valid values: 30 to 240. This… | | CapacityOptions | string | no | The capacity options (JSON-encoded) | | BalanceMode | string | no | The zone balance mode. This parameter takes effect only when zone balancing is enabled. Valid values: BalancedBestEffort: If resource… | | AutoRebalance | string | no | Specifies whether to enable automatic rebalancing for the scaling group. This parameter takes effect only when BalancedOnly is enabled for… | ### Creates a scaling rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group to which the scaling rule belongs | | ScalingRuleName | string | no | The name of the scaling rule. The name must be 2 to 64 characters in length and can contain digits, uppercase letters, lowercase letters,… | | Cooldown | integer | no | The cooldown time of the scaling rule. This parameter is applicable only to simple scaling rules. Valid values: 0 to 86400. Unit: seconds.… | | MinAdjustmentMagnitude | integer | no | The minimum number of instances to adjust in the scaling rule. This parameter takes effect only when the scaling rule type is… | | AdjustmentType | string | no | The adjustment method of the scaling rule. This parameter is applicable to simple scaling rules and step scaling rules, and is required in… | | AdjustmentValue | integer | no | The adjustment value of the scaling rule. This parameter is applicable to simple scaling rules and step scaling rules, and is required in… | | ScalingRuleType | string | no | The type of the scaling rule. Valid values: SimpleScalingRule: simple scaling. Adjusts the number of ECS or ECI instances based on the… | | EstimatedInstanceWarmup | integer | no | The warm-up period of an instance. This parameter is applicable to target tracking scaling rules and step scaling rules. An ECS instance… | | MetricName | string | no | The predefined metric. This parameter is applicable to target tracking scaling rules and predictive scaling rules, and is required in this… | | TargetValue | number | no | The target value. This parameter is applicable to target tracking scaling rules and predictive scaling rules, and is required in this… | | DisableScaleIn | string | no | Specifies whether to disable scale-in. This parameter is applicable only to target tracking scaling rules. Default value: false | | ScaleInEvaluationCount | integer | no | After a target tracking scaling rule is created, an event-triggered task is automatically created. This parameter specifies the number of… | | ScaleOutEvaluationCount | integer | no | After a target tracking scaling rule is created, an event-triggered task is automatically created. This parameter specifies the number of… | | PredictiveScalingMode | string | no | The mode of the predictive scaling rule. Valid values: PredictAndScale: generates prediction results and creates prediction tasks.… | | PredictiveValueBehavior | string | no | The method used to handle the maximum value for the predictive scaling rule. Valid values: MaxOverridePredictiveValue: the initial maximum… | | PredictiveValueBuffer | integer | no | This parameter takes effect when `PredictiveValueBehavior` is set to `PredictiveValueOverrideMaxWithBuffer`. The predicted value is… | | PredictiveTaskBufferTime | integer | no | The prediction tasks that are automatically created by the predictive scaling rule are executed on the hour by default. You can configure… | | InitialMaxSize | integer | no | The maximum number of instances in the scaling group. This parameter is used together with PredictiveValueBehavior. Default value: the… | | StepAdjustment | string | no | The collection of step adjustment information for the step scaling rule (JSON-encoded) | | RegionId | string | no | The region ID of the scaling group | | AlarmDimension | string | no | The dimension information associated with the metric. This parameter is applicable to target tracking scaling rules. Set this parameter… | | MetricType | string | no | The type of the metric. Valid values: system: uses CloudMonitor system metrics. custom: uses custom metrics reported to CloudMonitor.… | | HybridMonitorNamespace | string | no | The ID of the Hybrid Cloud Monitoring monitoring metrics repository. To manage metric repositories, see… | | HybridMetrics | string | no | The Hybrid Cloud Monitoring monitoring metrics settings. For more information about how to configure this parameter, see… | | AlarmOptions | string | no | The alert property definition (JSON-encoded) | ### Creates a scheduled task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/create-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region to which the scheduled task belongs | | ScheduledTaskName | string | no | The name of the scheduled task. The name must be 2 to 64 characters in length. It must start with a letter or digit and can contain… | | Description | string | no | The description of the scheduled task. The description must be 2 to 200 characters in length | | ScheduledAction | string | no | The unique identifier of the scaling rule to be executed when the scheduled task is triggered. After you specify this parameter, the… | | RecurrenceEndTime | string | no | The end time of the scheduled task that is executed repeatedly. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mmZ`… | | LaunchTime | string | no | The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time… | | RecurrenceType | string | no | The recurrence type of the scheduled task. Valid values: `Daily`: The scheduled task is executed once every specified number of days.… | | RecurrenceValue | string | no | The recurrence value of the scheduled task. If RecurrenceType is set to `Daily`, you can specify only one value. Valid values: 1 to 31. If… | | TaskEnabled | string | no | Specifies whether to start the scheduled task. Valid values: true: Starts the task. false: Stops the task. Default value: true | | LaunchExpirationTime | integer | no | The retry period after the scheduled task fails to be triggered. Unit: seconds. Valid values: 0 to 1800. Default value: 600 | | MinValue | integer | no | The minimum number of instances in the scaling group when the scaling method of the scheduled task is set to specifying the number of… | | MaxValue | integer | no | The maximum number of instances in the scaling group when the scaling method of the scheduled task is set to specifying the number of… | | DesiredCapacity | integer | no | The expected number of instances in the scaling group when the scaling method of the scheduled task is set to specifying the number of… | | ScalingGroupId | string | no | The ID of the scaling group for which you want to modify the number of instances when the scheduled task is triggered. After you specify… | ### Invalidates a specified scaling configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/deactivate-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingConfigurationId | string | yes | The ID of the scaling configuration | ### Deletes an event-triggered task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-alarm` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID | | AlarmTaskId | string | yes | The ID of the event-triggered task | ### Deletes a scaling configuration of the Elastic Container Instance (ECI) type `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-eci-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingConfigurationId | string | yes | The ID of the scaling configuration that you want to delete | | RegionId | string | no | The region ID of the scaling group | ### Deletes a lifecycle hook `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-lifecycle-hook` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | LifecycleHookId | string | no | The ID of the lifecycle hook | | ScalingGroupId | string | no | The ID of the scaling group | | LifecycleHookName | string | no | The name of the lifecycle hook | | RegionId | string | no | The region ID of the scaling group | ### Deletes an auto scaling event and resource change notification `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-notification-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | NotificationArn | string | yes | The identity of the Notification Recipient. The parameter format varies by notification method: monitoring:… | | RegionId | string | no | The region ID of the scaling group | ### Deletes a scaling configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingConfigurationId | string | yes | The ID of the scaling configuration that you want to delete | ### Deletes a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-scaling-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ForceDelete | string | no | Specifies whether to force delete the scaling group and remove and release ECS instances or elastic container instances if the scaling… | | RegionId | string | no | The region ID of the scaling group | ### Deletes a scaling rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingRuleId | string | yes | The ID of the scaling rule to be deleted | | RegionId | string | no | The ID of the region to which the scaling group belongs | ### Deletes a scheduled task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/delete-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScheduledTaskId | string | yes | The ID of the scheduled task. The ID is generated by the system and is globally unique | | RegionId | string | no | The region ID of the scheduled task | ### Queries information about event-triggered tasks `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-alarms` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the event-triggered task resides | | ScalingGroupId | string | no | The ID of the scaling group associated with the event-triggered task | | AlarmTaskId | string | no | The ID of the event-triggered task | | State | string | no | The state of the event-triggered task. Valid values: ALARM: The alert condition is met. OK: The alert condition is not met.… | | IsEnable | string | no | Specifies whether the event-triggered task is enabled. Valid values: true: enabled. false: disabled | | MetricType | string | no | The type of the monitoring metric. Valid values: system: uses CloudMonitor system metrics. custom: uses custom metrics reported to… | | MetricName | string | no | The name of the monitoring metric | | PageSize | integer | no | The number of entries per page for paging queries. Settings the number of rows per page. Maximum value: 50. Default value: 10 | | PageNumber | integer | no | The page number of the event-triggered task list. Minimum value: 1. Default value: 1 | ### When a scaling activity succeeds, fails, or is rejected, Auto Scaling can send notifications through SMS… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-alert-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | RegionId | string | yes | The ID of the region where the scaling group resides | ### Invokes the DescribeEciScalingConfigurations operation. You can specify parameters such as the scaling group… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-eci-scaling-configurations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group to which the scaling configuration belongs | | PageNumber | integer | no | The page number of the scaling configuration list. Pages start from 1. Default value: 1 | | PageSize | integer | no | The Settings for the number of entries per page during paging in a paged query. Maximum value: 50. Default value: 10 | | ScalingGroupId | string | no | The ID of the scaling group. You can query all scaling configurations in the scaling group | | ScalingConfigurationId | string | no | The IDs of the scaling configurations to query. You can specify 1 to 10 IDs. The query results include both active and inactive scaling… | | ScalingConfigurationName | string | no | The names of the scaling configurations to query. You can specify 1 to 10 names. The query ignores invalid scaling configuration names and… | ### The validity of a scaling group configuration largely determines the success rate of scale-out operations.… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-elastic-strength` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ScalingGroupId | string | no | The ID of the scaling group | | InstanceTypes | string | no | The collection of instance types for ECS instances. If specified, this parameter overrides the instance types in the scaling configuration… | | PriorityStrategy | string | no | This parameter is deprecated. Use SpotStrategy instead. The preemption policy for pay-as-you-go instances. If specified, this parameter… | | SystemDiskCategories | string | no | The system cloud disk types. If specified, this parameter overrides the system cloud disk types in the scaling configuration. Valid… | | ScalingGroupIds | string | no | The IDs of scaling groups for batch queries (JSON-encoded) | | SpotStrategy | string | no | The preemption policy for instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot instance with a… | | VSwitchIds | string | no | The IDs of multiple vSwitches. If you do not specify a scaling group ID, you must specify this parameter (JSON-encoded) | | ImageId | string | no | The ID of the image file. The image resource used for automatic creation of instances. If you do not specify a scaling group ID, you must… | | ImageName | string | no | The name of the image. Image names are unique within a region. If ImageId is specified, ImageName is ignored. You cannot use ImageName to… | | ImageFamily | string | no | The name of the image family. If you specify this parameter, the latest available image in the specified image family is used to create… | | DataDiskCategories | string | no | The elastic strength when multiple data cloud disk types are specified. If a data cloud disk type does not match, the specific mismatched… | | Ipv6AddressCount | integer | no | The number of IPv6 addresses. If the instance type does not meet the IPv6 address count requirement, the elastic strength is degraded. If… | ### Queries instance refresh tasks of a scaling group, including basic information and progress of the tasks `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-instance-refreshes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | NextToken | string | no | The pagination token. Set this parameter to the NextToken value returned in the previous call. You do not need to set this parameter for… | | MaxResults | integer | no | The maximum number of entries per page in a paging query. Valid values: 1 to 50. Default value: 10 | | ScalingGroupId | string | yes | The ID of the scaling group | | InstanceRefreshTaskId | string | no | The ID of the instance refresh task that you want to query (JSON-encoded) | ### Queries lifecycle tokens by scaling activity ID and status `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-lifecycle-actions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingActivityId | string | yes | The ID of the scaling activity | | LifecycleActionStatus | string | no | The status of the lifecycle action. Valid values: Pending: The ECS instance is still in the wait state. Timeout: The timeout period of the… | | NextToken | string | no | The pagination token that is used to specify the position from which to start the query. For example, if you queried 10 lifecycle actions… | | MaxResults | integer | no | The maximum number of entries per page. Valid values: 1 to 50. Default value: 10 | | RegionId | string | no | The region ID of the scaling group | ### Queries information about lifecycle hooks by lifecycle hook ID or scaling group ID, including the default… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-lifecycle-hooks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | no | The ID of the scaling group | | LifecycleHookName | string | no | The name of the lifecycle hook | | PageNumber | integer | no | The page number of the instance status list. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 50. Default value: 50 | | LifecycleHookId | string | no | The list of lifecycle hook IDs (JSON-encoded) | | RegionId | string | no | The ID of the region where the scaling group resides | ### Queries resource quota limits `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-limitation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | ### Queries the notification configurations for Auto Scaling events and resource changes of a scaling group,… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-notification-configurations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | RegionId | string | no | The ID of the region where the scaling group resides | ### Queries the types of Auto Scaling events and resource change notifications `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-notification-types` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | ### Queries instance types that match specified instance attributes, such as the number of vCPUs, memory size,… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-pattern-types` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID | | VSwitchId | string | no | The IDs of vSwitches (JSON-encoded) | | ZoneId | string | no | The IDs of zones. This parameter is invalid if you specify vSwitch IDs (JSON-encoded) | | SpotStrategy | string | no | The bidding policy for pay-as-you-go instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot… | | Cores | integer | no | The number of vCPUs of the instance type | | Memory | number | no | The memory size of the instance type. Unit: GiB | | MaxPrice | number | no | The maximum hourly price acceptable for pay-as-you-go or spot instances | | InstanceFamilyLevel | string | no | The instance family level. Valid values: EntryLevel: entry level, which refers to shared instance types. These instance types are more… | | ExcludedInstanceType | string | no | The instance types to exclude. You can use wildcard characters (*) to exclude a single instance type or an entire instance family.… | | Architecture | string | no | The architecture type of the instance type. Valid values: X86: x86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA.… | | BurstablePerformance | string | no | Specifies whether to include burstable instance types. Valid values: Exclude: excludes burstable instance types. Include: includes… | | CoresList | string | no | The number of vCPUs of the instance type. You can specify multiple values (JSON-encoded) | | MemoryList | string | no | The memory size of the instance type. Unit: GiB. You can specify multiple values (JSON-encoded) | | ChannelId | integer | no | The channel ID. This parameter is reserved for internal use only | | InstanceTypeFamilies | string | no | The instance families to query. N specifies that you can set multiple instance families. Valid values of N: 1 to 10 (JSON-encoded) | | MinimumCpuCoreCount | integer | no | The minimum number of vCPUs of the instance type | | MaximumCpuCoreCount | integer | no | The maximum number of vCPUs of the instance type | | GpuSpecs | string | no | The GPU type (JSON-encoded) | | InstanceCategories | string | no | The instance type categorization. Valid values: General-purpose: general-purpose. Compute-optimized: compute-optimized. Memory-optimized:… | | CpuArchitectures | string | no | The CPU architectures of the instance type (JSON-encoded) | | PhysicalProcessorModels | string | no | The processor models of the instance. N specifies that you can set multiple processor models. Valid values of N: 1 to 10 (JSON-encoded) | | MinimumEniQuantity | integer | no | The minimum number of elastic network interfaces (ENIs) that can be attached to the instance | | MinimumEniPrivateIpAddressQuantity | integer | no | The minimum number of IPv4 addresses per elastic network interfaces (ENIs) on the instance | | MinimumEniIpv6AddressQuantity | integer | no | The minimum number of IPv6 addresses per elastic network interfaces (ENIs) on the instance | | MinimumInitialCredit | integer | no | The minimum initial vCPU credits for burstable instances (t5 and t6) | | MinimumBaselineCredit | integer | no | The minimum baseline vCPU computing performance (sum of all vCPUs) for burstable instances (t5 and t6) | | MinimumMemorySize | number | no | The minimum memory size of the instance. Unit: GiB | | MaximumMemorySize | number | no | The maximum memory size of the instance. Unit: GiB | | MinimumGpuAmount | integer | no | The minimum number of GPUs on the instance. Valid values: positive integers | | MaximumGpuAmount | integer | no | The maximum number of GPUs on the instance. Valid values: positive integers | ### Queries the regions where Auto Scaling is available `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | AcceptLanguage | string | no | Filters the results based on the specified language. For more information, see RFC7231 (https://tools.ietf.org/html/rfc7231). Valid… | ### Queries the details of scaling activities by calling the DescribeScalingActivities operation. You can use… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scaling-activities` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group to which the scaling activities belong | | PageNumber | integer | no | The page number of the scaling activity list. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 50. Default value: 10 | | ScalingGroupId | string | no | The ID of the scaling group. When you call this operation, you must specify either ScalingGroupId or ScalingActivityId.N. An error is… | | StatusCode | string | no | The status of the scaling activity. Valid values: Successful: The scaling activity was executed successfully. Warning: The scaling… | | ScalingActivityId | string | no | The IDs of the scaling activities that you want to query. When you call this operation, you must specify either ScalingGroupId or… | | InstanceRefreshTaskId | string | no | The ID of the instance refresh task. You can specify this parameter to query the list of scaling activities associated with the instance… | ### Queries the details of a scaling activity `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scaling-activity-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingActivityId | string | yes | The ID of the scaling activity that you want to query. You can call https://help.aliyun.com/document_detail/25961.html to query scaling… | ### Queries information about ECS-type scaling configurations, including instance types and images, to help you… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scaling-configurations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group to which the scaling configurations belong | | PageNumber | integer | no | The page number of the scaling configuration list. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page for a paged query. Maximum value: 50. Default value: 10 | | ScalingGroupId | string | no | The ID of the scaling group. You can query all scaling configurations in the specified scaling group | | ScalingConfigurationId | string | no | The ID of the scaling configuration that you want to query. The query results include both active and inactive scaling configurations,… | | ScalingConfigurationName | string | no | The name of the scaling configuration that you want to query. The query results ignore the names of inactive scaling configurations, and… | ### Queries scaling groups. You can call this operation to view basic information about scaling groups,… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scaling-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | PageNumber | integer | no | The page number of the scaling group list. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page when you use paging. Maximum value: 50. Default value: 10 | | ScalingGroupName | string | no | The name of the scaling group | | ScalingGroupName.1 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.2 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.3 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.4 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.5 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.6 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.7 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.8 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.9 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.10 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.11 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.12 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.13 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.14 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.15 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.16 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.17 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.18 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.19 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | ScalingGroupName.20 | string | no | The name of scaling group N that you want to query. Invalid scaling group names are ignored and no error is returned | | GroupType | string | no | The type of instances managed by the scaling group. Valid values: ECS: ECS instances are managed by the scaling group. ECI: ECI instances… | | ScalingGroupId | string | no | The ID of scaling group N that you want to query. Valid values of N: 1 to 20. Invalid scaling group IDs are ignored and no error is… | | ResourceGroupId | string | no | The ID of the resource group to which the scaling group belongs. If no scaling group belongs to the specified resource group, an empty… | | Tag | string | no | The tags of the scaling group (JSON-encoded) | ### Queries the list of ECS instances in a scaling group and instance information by scaling group ID, including… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scaling-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the scaling group resides | | ScalingGroupId | string | no | The ID of the scaling group | | ScalingConfigurationId | string | no | The ID of the associated scaling configuration | | HealthStatus | string | no | The health check status of the ECS instance or elastic container instance in the scaling group. ECS instances or elastic container… | | LifecycleState | string | no | The lifecycle state of the ECS instance, elastic container instance, or managed instance in the scaling group. Valid values: InService:… | | CreationType | string | no | The method used to create instances in the scaling group. Valid values: AutoCreated: The ECS instance or elastic container instance is… | | PageNumber | integer | no | The page number of the instance list. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page for paging. Maximum value: 100. Default value: 10 | | ScalingActivityId | string | no | The ID of the scaling activity | | InstanceId | string | no | The IDs of instances in the scaling group (JSON-encoded) | | CreationTypes | string | no | The methods used to create instances in the scaling group. You can specify only one of this parameter and CreationType (JSON-encoded) | | LifecycleStates | string | no | The lifecycle states of ECS instances, elastic container instances, or managed instances in the scaling group. You can specify only one of… | ### Queries the scaling rules in a scaling group and returns information about the scaling rules `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scaling-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group to which the scaling rules belong | | PageNumber | integer | no | The page number of the scaling rule list. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page for paging queries. Settings: maximum value: 50. Default value: 10 | | ScalingGroupId | string | no | The ID of the scaling group | | ScalingRuleType | string | no | The type of the scaling rule. Valid values: SimpleScalingRule: simple scaling. Adjusts the number of ECS instances based on the adjustment… | | ShowAlarmRules | string | no | Specifies whether to return the CloudMonitor event-triggered tasks associated with the scaling rules. Valid values: true: Returns the… | | ScalingRuleId | string | no | The ID of scaling rule N that you want to query. Valid values of N: 1 to 10 (JSON-encoded) | | ScalingRuleName | string | no | The name of scaling rule N that you want to query. Valid values of N: 1 to 10 (JSON-encoded) | | ScalingRuleAri | string | no | The unique identifier of scaling rule N that you want to query. Valid values of N: 1 to 10 (JSON-encoded) | ### Queries the details of scheduled nodes. A scheduled node is a preset node that executes a specified scaling… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/describe-scheduled-tasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group to which the scheduled task belongs | | PageNumber | integer | no | The page number of the scheduled task list. Pages start from page 1. Default value: 1 | | PageSize | integer | no | The Settings for the number of entries to return on each page during paging in a paged query. Maximum value: 50. Default value: 10 | | ScalingGroupId | string | no | The ID of the scaling group that executes the scheduled task | | ScheduledAction | string | no | The scaling rule to be executed when the scheduled task is triggered. This parameter is valid only when a scaling rule is specified for… | | ScheduledTaskId | string | no | The ID of the scheduled task to be queried (JSON-encoded) | | ScheduledTaskName | string | no | The name of the scheduled task to be queried (JSON-encoded) | | TaskName | string | no | The name of the task. Fuzzy search by keyword is supported | | RecurrenceType | string | no | The recurrence type of the scheduled task. Valid values: Daily: The scheduled task is executed once every specified number of days.… | | RecurrenceValue | string | no | The recurrence value of the scheduled task. This parameter is supported only when RecurrenceType is set to Weekly. You can specify… | | TaskEnabled | string | no | Specifies whether the scheduled task is started. Valid values: true: The task is started. false: The task is stopped | ### Removes one or more Application Load Balancer (ALB) server groups from a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/detach-alb-server-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group, such as ap-southeast-1. For more information, see https://help.aliyun.com/document_detail/40654.html | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | ForceDetach | string | no | Specifies whether to remove existing ECS instances from the ALB server groups to be detached. true: removes the instances and returns a… | | AlbServerGroup | string | yes | The list of ALB server groups (JSON-encoded) | ### Removes one or more ApsaraDB RDS instances `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/detach-dbinstances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ForceDetach | string | no | Specifies whether to remove the private IP addresses of instances in the scaling group from the IP whitelist of the RDS instance when the… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | DBInstance | string | yes | The ID of the RDS instance. You can remove up to five RDS instances at a time (JSON-encoded) | | RegionId | string | no | The region ID of the scaling group | | RemoveSecurityGroup | string | no | Specifies whether to remove the security group whitelist that was added when the scaling group was associated with the database. This… | ### Removes one or more ECS instances from a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/detach-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | DecreaseDesiredCapacity | string | no | Specifies whether to modify the expected number of instances. Valid values: true: After the ECS instances, elastic container instances, or… | | IgnoreInvalidInstance | string | no | Specifies whether to ignore invalid instances when removing a batch of instances from the scaling group. Valid values: true: Invalid… | | DetachOption | string | no | Specifies whether to stop using ECS instances or elastic container instances as backend servers of the associated load balancing instance… | | InstanceId | string | yes | The ID of the ECS instance, elastic container instance, or managed instance to be removed (JSON-encoded) | | LifecycleHook | string | no | Specifies whether to trigger the scale-in lifecycle hook when ECS instances or elastic container instances are removed from the scaling… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… | ### Removes one or more load balancing instances `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/detach-load-balancers` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ForceDetach | string | no | Specifies whether to remove the ECS instances that belong to the current scaling group from the backend servers of the load balancing… | | ClientToken | string | no | Ensures the idempotence of the request. Generate a parameter value on your client to ensure that the value is unique across different… | | Async | string | no | Specifies whether to use asynchronous calls when removing load balancing instances. Asynchronous calls ensure the transactionality of… | | LoadBalancer | string | yes | The IDs of the load balancing instances. You can specify up to five load balancing instances at a time (JSON-encoded) | | RegionId | string | no | The ID of the region to which the scaling group belongs | ### Invokes the DetachServerGroups API to remove one or more load balancing server groups from a scaling group.… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/detach-server-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | Ensures the idempotence of the request. You can generate the value on the client side to ensure that the value is unique across different… | | ForceDetach | string | no | Specifies whether to remove the ECS instances or ECI instances in the current scaling group from the server groups to be detached. Valid… | | ServerGroup | string | yes | The information about the load balancing server groups (JSON-encoded) | ### Removes one or more virtual server groups `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/detach-vserver-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the scaling group resides, such as `cn-hangzhou` or `cn-shanghai`. For more information, see… | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | ForceDetach | string | no | Specifies whether to remove the instances in the current scaling group from the virtual server groups that you want to remove. true: The… | | VServerGroup | string | yes | The information about the virtual server groups associated with the scaling group (JSON-encoded) | ### Disables an event-triggered task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/disable-alarm` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID | | AlarmTaskId | string | yes | The ID of the event-triggered task | ### Disables a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/disable-scaling-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | ### Enables an event-triggered task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/enable-alarm` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID | | AlarmTaskId | string | yes | The ID of the event-triggered task | ### Enables a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/enable-scaling-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ActiveScalingConfigurationId | string | no | The ID of the scaling configuration to be activated in the scaling group | | LaunchTemplateId | string | no | The ID of the launch template. This parameter specifies that the scaling group obtains launch configuration information from the launch… | | LaunchTemplateVersion | string | no | The version of the launch template. Valid values: A fixed template version number. Default: always uses the default version of the… | | InstanceId | string | no | The ID of the ECS instance to add to the scaling group after the scaling group is enabled. Valid values of N: 1 to 20. The ECS instances… | | LoadBalancerWeight | string | no | The weight of the ECS instance or elastic container instance as a backend server of the associated Server Load Balancer (SLB) instance.… | | LaunchTemplateOverride | string | no | The override information of the launch template (JSON-encoded) | | RegionId | string | no | The region ID of the scaling group | ### Sets ECS instances in a scaling group to the standby state `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/enter-standby` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | InstanceId | string | yes | The ID of the ECS instance or elastic container instance (JSON-encoded) | | Async | string | no | Specifies whether to use an asynchronous task. Valid values: true: The request is processed asynchronously. false: The request is… | ### Executes a scaling rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/execute-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingRuleAri | string | yes | The unique identifier of the scaling rule. When you call this operation to execute a scaling rule, only simple scaling rules and step… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | BreachThreshold | number | no | The current threshold specified when a step scaling rule is executed. Valid values: -9.999999E18 to 9.999999E18 | | MetricValue | number | no | The current metric value specified when a step scaling rule is executed. Valid values: -9.999999E18 to 9.999999E18 | | RegionId | string | no | The region ID of the scaling rule | ### Restores ECS instances in a scaling group from the standby state to the running state `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/exit-standby` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | Ensures the idempotence of the request. You can generate the value from your client to ensure that the value is unique across different… | | InstanceId | string | yes | The ID of the ECS instance (JSON-encoded) | | Async | string | no | Specifies whether to execute asynchronous task asynchronously. Valid values: true: Asynchronous task is executed asynchronously. false:… | | RegionId | string | no | The ID of the region to which the scaling group belongs | ### Queries the tag keys of Auto Scaling resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/list-tag-keys` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the Auto Scaling resources | | ResourceType | string | yes | The Auto Scaling resource type. Valid values: `scalinggroup`, which indicates that the tags are bound to scaling groups | | NextToken | string | no | The token used to start the next query. If the value is empty, no more results are available | | PageSize | integer | no | The paging settings for the number of entries per page in a paged query. Maximum value: 50. Default value: 10 | ### Queries the tags that are attached to one or more Auto Scaling resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/list-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the resource. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list | | ResourceType | string | yes | The resource type. Only scaling groups are supported. Valid values: scalinggroup | | NextToken | string | no | The token that determines the start point of the next query | | ResourceId | string | no | The resource ID. Valid values of N: 1 to 50 (JSON-encoded) | | Tag | string | no | The tags (JSON-encoded) | ### Queries the tag values corresponding to a tag key of Auto Scaling resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/list-tag-values` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region to which the Auto Scaling resource belongs | | ResourceType | string | yes | The type of the Auto Scaling resource. Valid values: scalinggroup, which indicates that the tag is bound to a scaling group | | NextToken | string | no | The token used to start the next query. If NextToken is empty, no more results are available | | PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 50. Default value: 10 | | Key | string | yes | The tag key | ### Modifies an event-triggered task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-alarm` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the event-triggered task | | AlarmTaskId | string | yes | The ID of the event-triggered task | | Name | string | no | The name of the event-triggered task | | Description | string | no | The description of the event-triggered task | | MetricName | string | no | The metric name. Valid values vary based on the monitoring type of the event-triggered task: If the event-triggered task is of the custom… | | MetricType | string | no | The monitoring type. Valid values: system: uses CloudMonitor system metrics. custom: uses custom metrics reported to CloudMonitor | | Period | integer | no | The statistical period for the metric data, in seconds. Valid values: 15. 60. 120. 300. 900. Only scaling groups of the ECS type support a… | | Statistics | string | no | The method used to aggregate metric data. Valid values: Average: average value. Minimum: minimum value. Maximum: maximum value | | Threshold | number | no | The threshold of the monitoring metrics. When the threshold expression is met the specified number of times, the scaling rule is triggered | | ComparisonOperator | string | no | The comparison operator between the metric value and the threshold. This parameter specifies the condition under which the metric value… | | EvaluationCount | integer | no | The number of consecutive times that the threshold expression must be met before the scaling rule is triggered. For example, the average… | | GroupId | integer | no | The ID of the CloudMonitor application group to which the custom metric belongs. This parameter is required only when MetricType is set to… | | Effective | string | no | The effective period of the event-triggered task. This parameter follows cron expressions. The default format is `X X X X X ?`, where: X:… | | AlarmAction | string | no | The unique identifiers of the scaling rules associated with the event-triggered task (JSON-encoded) | | Dimension | string | no | The dimension information associated with the metric (JSON-encoded) | | Expression | string | no | The information about multi-metric alert rules (JSON-encoded) | | ExpressionsLogicOperator | string | no | The logical operator between multi-metric alert conditions. Valid values: `&&`: An alert is triggered only when all monitoring metrics… | ### Configures the scaling activity statuses for which Auto Scaling sends SMS and email notifications within a… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-alert-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | RegionId | string | yes | The region ID of the scaling group | | ScaleStatus | string | no | The scaling activity statuses for which SMS and email notifications are sent in the scaling group (JSON-encoded) | ### Modifies an ECI-type scaling configuration `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-eci-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingConfigurationId | string | yes | The ID of the scaling configuration to be modified | | ScalingConfigurationName | string | no | The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, Chinese characters,… | | SecurityGroupId | string | no | The ID of the security group to which the ECI instance belongs. ECI instances in the same security group can access each other. If you do… | | ContainerGroupName | string | no | The name of the ECI instance, which is also the name of the container group. The format requirements are as follows: The name must be 2 to… | | RestartPolicy | string | no | The restart policy of the instance. Valid values: Always: The instance always restarts. Never: The instance never restarts. OnFailure: The… | | Cpu | number | no | The number of vCPUs at the instance level. Unit: cores | | Memory | number | no | The memory size at the instance level. Unit: GiB | | ResourceGroupId | string | no | The ID of the resource group | | DnsPolicy | string | no | The DNS policy. Valid values: None: Uses the DNS settings specified in the DnsConfig field. Default: Inherits the DNS settings from the… | | ImageSnapshotId | string | no | The ID of the image cache | | RamRoleName | string | no | The name of the instance RAM role. ECI and ECS share instance RAM roles. For more information, see… | | TerminationGracePeriodSeconds | integer | no | The grace period for the program to handle operations before shutdown. Unit: seconds | | AutoMatchImageCache | string | no | Specifies whether to automatically match an image cache. Valid values: true: Yes. false: No. Default value: false | | Ipv6AddressCount | integer | no | The number of IPv6 addresses | | ActiveDeadlineSeconds | integer | no | The validity period. Unit: seconds | | SpotStrategy | string | no | The spot strategy of the instance. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: The… | | SpotPriceLimit | number | no | The maximum hourly price of a spot instance. The value can contain up to three decimal places. When SpotStrategy is set to… | | AutoCreateEip | string | no | Specifies whether it is required to perform automatic creation of an elastic IP address and attach it to the ECI instance | | EipBandwidth | integer | no | The bandwidth of the elastic IP address. Default value: 5 Mbit/s | | HostName | string | no | The hostname, which is also the container group name | | IngressBandwidth | integer | no | The inbound bandwidth limit. Unit: bytes | | EgressBandwidth | integer | no | The outbound bandwidth limit. Unit: bytes | | CpuOptionsCore | integer | no | The number of physical CPU cores. Only some instance types support custom settings. For more information, see… | | CpuOptionsThreadsPerCore | integer | no | The number of threads per core. Only some instance types support custom settings. A value of 1 disables hyper-threading. For more… | | EphemeralStorage | integer | no | The size of the ephemeral storage. By default, an ESSD PL1 cloud disk is used. Unit: GiB | | LoadBalancerWeight | integer | no | The weight of the backend server. Valid values: 1 to 100 | | Tag | string | no | The tag key-value pairs of the instance (JSON-encoded) | | ImageRegistryCredential | string | no | The image registry information (JSON-encoded) | | Container | string | no | The list of containers included in the instance (JSON-encoded) | | Volume | string | no | The volume information (JSON-encoded) | | InitContainer | string | no | The list of init containers (JSON-encoded) | | DnsConfigNameServer | string | no | The list of IP addresses of DNS servers (JSON-encoded) | | DnsConfigSearch | string | no | The list of DNS search domains (JSON-encoded) | | DnsConfigOption | string | no | The list of object options. Each object consists of a Name and an optional Value (JSON-encoded) | | HostAliase | string | no | The custom hostname mapping for a container in the instance (JSON-encoded) | | SecurityContextSysctl | string | no | The security context for the pod runtime (JSON-encoded) | | NtpServer | string | no | The NTP server (JSON-encoded) | | AcrRegistryInfo | string | no | The information about the ACR Enterprise instance (JSON-encoded) | | CostOptimization | string | no | Specifies whether to enable cost optimization. Valid values: true: Enabled. false: Disabled. Default value: false | | InstanceFamilyLevel | string | no | The instance family level. This parameter is used to filter instance types that meet the requirements and takes effect only when… | | ContainersUpdateType | string | no | The control parameter for the update method of the Containers parameter. Valid values: RenewUpdate: Full update. The Containers parameter… | | InstanceType | string | no | The ECS instance type. You can specify up to five instance types (JSON-encoded) | | DataCacheBucket | string | no | The data cache bucket | | DataCachePL | string | no | The performance level of the cloud disk used for data caching. We recommend ESSDs. Valid values for ESSDs: PL0: Up to 10,000 random… | | DataCacheProvisionedIops | integer | no | The provisioned read/write IOPS of the ESSD AutoPL cloud disk used for data caching. Valid values: 0 to min{50000, 1000 × Capacity -… | | DataCacheBurstingEnabled | string | no | Specifies whether to enable the burstable performance feature when an ESSD AutoPL cloud disk is used for data caching. Valid values: true:… | | GpuDriverVersion | string | no | The GPU driver version. Valid values: tesla=470.82.01 (default) tesla=525.85.12 Only specific instance types support switching the GPU… | | Override | string | no | Specifies whether to overwrite. Valid values: true: Overwrite. false: Do not overwrite | ### Modifies specific attributes of an ECS instance in a scaling group by specifying parameters such as the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-instance-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the ECS instance in the scaling group | | InstanceId | string | no | The ID of the scaling group | | Entrusted | string | no | Specifies whether to entrust the lifecycle of an ECS instance manually added to a scaling group to the scaling group. Valid values: true:… | | RegionId | string | yes | The region ID of the scaling group | | InstanceIds | string | no | The IDs of the ECS instances in the scaling group (JSON-encoded) | ### Modifies the information of a lifecycle hook `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-lifecycle-hook` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | LifecycleHookId | string | no | The ID of the lifecycle hook to be modified. This parameter is used to specify the lifecycle hook | | ScalingGroupId | string | no | The ID of the scaling group. This parameter is used to specify the lifecycle hook | | LifecycleHookName | string | no | The name of the lifecycle hook to be modified. This parameter is used to specify the lifecycle hook | | DefaultResult | string | no | The next action to perform after the wait state ends. Valid values: CONTINUE: Continues to respond to the scale-out or scale-in activity.… | | HeartbeatTimeout | integer | no | The wait time set by the lifecycle hook for the scaling activity. After the wait state times out, the next action is performed. Valid… | | LifecycleTransition | string | no | The type of scaling activity to which the hook applies. Valid values: SCALE_OUT: scale-out activities of the scaling group. SCALE_IN:… | | NotificationMetadata | string | no | The fixed string information for the wait state of the scaling activity. The value can be up to 4,096 characters in length. Each time Auto… | | NotificationArn | string | no | The identifier of the notification recipient for the lifecycle hook. The following notification methods are supported when you set this… | | RegionId | string | no | The ID of the region to which the scaling group belongs | | LifecycleHookStatus | string | no | The status to which you want to change the lifecycle hook. Valid values: Active: starts the lifecycle hook. InActive: pauses the lifecycle… | ### Modifies an Auto Scaling event and resource change notification `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-notification-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | NotificationArn | string | yes | The identifier of the notification recipient. When you set this parameter, the following notification methods are supported: CloudMonitor:… | | NotificationType | string | yes | The types of Auto Scaling events and resource change notifications. Valid values of N: 1 to 8 (JSON-encoded) | | RegionId | string | no | The region ID of the scaling group | | TimeZone | string | no | The time zone for message notifications. Specify the time zone offset from Coordinated Universal Time (UTC), such as UTC+8 and UTC-7 | | MessageEncoding | string | no | The encoding method for the message notification content. Valid values: PlainText: No encoding is used. The content is transmitted in… | ### Modifies an ECS-type scaling configuration (the ECS instance template for scale-out) if the current scaling… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-scaling-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingConfigurationId | string | yes | The ID of the scaling configuration that you want to modify | | IoOptimized | string | no | Specifies whether the instance is an I/O optimization instance. Valid values: none: The instance is not an I/O optimization instance.… | | SpotStrategy | string | no | The preemption policy for pay-as-you-go instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a spot… | | ScalingConfigurationName | string | no | The name of the scaling configuration. The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_),… | | InstanceName | string | no | The name of the ECS instance that is created by automatic creation based on the scaling configuration | | HostName | string | no | The hostname of the Elastic Computing Service (ECS) server. A period (.) or a hyphen (-) cannot be used as the first or last character, or… | | ImageId | string | no | The ID of the image file used for automatic creation of instances. If the image previously used in the scaling configuration includes a… | | ImageName | string | no | The name of the image file. Image names must be unique within a region. If you specify ImageId, ImageName is ignored. You cannot use… | | Cpu | integer | no | The number of vCPUs. You can specify both CPU and Memory to define the range of instance types. For example, setting CPU to 2 and Memory… | | Memory | integer | no | The memory size. You can specify both CPU and Memory to define the range of instance types. For example, setting CPU to 2 and Memory to 16… | | InternetChargeType | string | no | The billing method for network usage. Valid values: PayByBandwidth: pay-by-bandwidth. The value of InternetMaxBandwidthOut is used as the… | | InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. Default value: 0 | | SystemDisk.Category | string | no | The category of the system cloud disk. Valid values: cloud: basic cloud disk. The DeleteWithInstance property of a basic cloud disk… | | SystemDisk.Size | integer | no | The size of the system cloud disk. Unit: GiB. Valid values: Basic cloud disk: 20 to 500. ESSD: - PL0: 1 to 2048. - PL1: 20 to 2048. - PL2:… | | SystemDisk.DiskName | string | no | The name of the system cloud disk. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores… | | SystemDisk.Description | string | no | The description of the system cloud disk. The description must be 2 to 256 characters in length and cannot start with `http://` or… | | SystemDisk.AutoSnapshotPolicyId | string | no | The ID of the automatic snapshot policy that is applied to the system cloud disk | | SystemDisk.PerformanceLevel | string | no | The performance level (PL) of the system cloud disk when the disk is an ESSD. Valid values: PL0: A single ESSD can deliver up to 10,000… | | LoadBalancerWeight | integer | no | The weight of SLB backend server. Valid values: 1 to 100 | | UserData | string | no | The user data of the ECS instance. The data must be encoded in Base64. The maximum size of the raw data before encoding is 32 KB | | KeyPairName | string | no | The name of the key pair used to log on to the ECS instance. For Windows instances, this parameter is ignored and is empty by default. For… | | RamRoleName | string | no | The name of the RAM role associated with the ECS instance. The name is provided and maintained by RAM. You can call… | | PasswordInherit | string | no | Specifies whether to use the password preset in the image. To use this parameter, make sure that a password is configured for the image | | Tags | string | no | The tags of the ECS instance. Tags are specified as key-value pairs. You can specify up to 20 tags. The following limits apply to keys and… | | DeploymentSetId | string | no | The ID of the deployment set to which the ECS instance belongs | | SecurityGroupId | string | no | The ID of the security group to which the ECS instance belongs. ECS instances in the same security group can access each other | | Override | string | no | Specifies whether to override existing data. Valid values: true: overrides existing data. false: does not override existing data | | ResourceGroupId | string | no | The ID of the resource group to which the ECS instance belongs | | HpcClusterId | string | no | The ID of the HPC cluster to which the ECS instance belongs | | InstanceDescription | string | no | The description of the ECS instance. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` | | Ipv6AddressCount | integer | no | The number of randomly generated IPv6 addresses allocated to the network interface controller (NIC) | | CreditSpecification | string | no | The running mode of the burstable instance. Valid values: Standard: standard mode. For more information, see the performance constrained… | | ImageFamily | string | no | The name of the image family. You can specify this parameter to obtain the latest available image from the specified image family for… | | ZoneId | string | no | The zone ID of the ECS instance | | DedicatedHostId | string | no | Specifies whether to create the ECS instance on a dedicated host. Because dedicated hosts do not support the creation of spot instances,… | | Affinity | string | no | Specifies whether the instance on a dedicated host is associated with the dedicated host. Valid values: default: The instance is not… | | Tenancy | string | no | Specifies whether to create the instance on a dedicated host. Valid values: default: creates an instance that is not on a dedicated host.… | | SchedulerOptions | string | no | The scheduler options (JSON-encoded) | | PrivatePoolOptions.MatchCriteria | string | no | The private pool option for instance startup. After an elasticity assurance or capacity reservation takes effect, a private pool is… | | PrivatePoolOptions.Id | string | no | The ID of the private pool. The private pool ID is the same as the ID of the elasticity assurance or capacity reservation | | SpotDuration | integer | no | The retention period of the spot instance. Unit: hours. Valid values: 1: After the instance is created, Alibaba Cloud ensures that the… | | SpotInterruptionBehavior | string | no | The interruption mode of the spot instance. Only Terminate (default) is supported, which directly releases the instance | | DataDisk | string | no | The list of data cloud disks (JSON-encoded) | | SpotPriceLimit | string | no | The collection of spot instance information (JSON-encoded) | | InstanceTypes | string | no | The instance types for multiple instance type support. If InstanceTypes.N is specified, InstanceType is ignored. Valid values of N: 1 to… | | InstanceTypeOverride | string | no | The instance type-related information (JSON-encoded) | | SecurityGroupIds | string | no | The IDs of the security groups to which the ECS instance is added. The valid values of N depend on the maximum number of security groups… | | InstancePatternInfo | string | no | The instance type-related information in intelligent mode (JSON-encoded) | | SystemDiskCategories | string | no | The disk types for the system cloud disk. Valid values of N: 1 to 4. You can specify up to four disk types for the system cloud disk in a… | | Password | string | no | The password of the ECS instance. The password must be 8 to 30 characters in length and must contain at least three of the following… | | SystemDisk.Encrypted | string | no | Specifies whether to encrypt the system cloud disk. Valid values: true: The system cloud disk is encrypted. false: The system cloud disk… | | SystemDisk.KMSKeyId | string | no | The ID of the Key Management Service (KMS) key used by the system cloud disk | | SystemDisk.EncryptAlgorithm | string | no | The encryption algorithm used by the system cloud disk. Valid values: AES-256. SM4-128. Default value: AES-256 | | SystemDisk.ProvisionedIops | integer | no | The provisioned IOPS (Input/Output Operations Per Second) performance metrics of the system cloud disk. IOPS (Input/Output Operations Per… | | SystemDisk.BurstingEnabled | string | no | Specifies whether to enable the burst (performance burst) feature for the system cloud disk. Valid values: true: Enabled. false: Not… | | ImageOptions.LoginAsNonRoot | string | no | Specifies whether the ECS instance uses the ecs-user user for logon. For more information, see… | | DeletionProtection | string | no | The release protection property of the ECS instance. This property applies only to pay-as-you-go instances and specifies whether the… | | StorageSetId | string | no | The ID of the storage set | | StorageSetPartitionNumber | integer | no | The maximum number of partitions in the storage set. Valid values: greater than or equal to 2 | | CustomPriorities | string | no | The custom priorities for ECS instance type + vSwitch combinations. This parameter takes effect only when the `scaling policy` of the… | | NetworkInterfaces | string | no | The list of elastic network interfaces (ENIs) (JSON-encoded) | | DedicatedHostClusterId | string | no | The ID of the dedicated host cluster | | SecurityOptions | string | no | The security options (JSON-encoded) | | HttpEndpoint | string | no | Specifies whether to enable the access channel for instance metadata. Valid values: enabled: Enabled. disabled: Disabled. Default value:… | | HttpTokens | string | no | Specifies whether to forcefully use the security-hardened mode (IMDSv2) to access instance metadata. Valid values: optional: The… | | InternetMaxBandwidthIn | integer | no | The maximum inbound public bandwidth. Unit: Mbit/s. Valid values: If the purchased outbound public bandwidth is less than or equal to 10… | | ResourcePoolOptions | string | no | The resource pool policy used when creating instances. After you specify this parameter, note the following items: This parameter takes… | | SecondaryEniVSwitchConstraint | string | no | Specifies whether a vSwitch must be selected from the VSwitchIds list for the secondary elastic network interface (ENI) when the… | ### If you need to automatically increase or decrease the number of instances of a specific type based on… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-scaling-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group that you want to modify | | ScalingGroupName | string | no | The name of the scaling group. The name must be unique within a region. The name must be 2 to 64 characters in length and can contain… | | MinSize | integer | no | The minimum number of ECS instances or elastic container instances in the scaling group. When the number of ECS or elastic container… | | MaxSize | integer | no | The maximum number of ECS instances or elastic container instances in the scaling group. When the number of ECS or elastic container… | | DefaultCooldown | integer | no | The cooldown time after a scaling activity (adding or removing ECS instances or elastic container instances) is complete. Valid values: 0… | | RemovalPolicy.1 | string | no | The first-priority scale-in policy for removing ECS instances from the scaling group. Valid values: OldestInstance: removes the ECS… | | RemovalPolicy.2 | string | no | The second-priority scale-in policy for removing ECS instances from the scaling group. Valid values: OldestInstance: removes the ECS… | | RemovalPolicy.3 | string | no | The third-priority scale-in policy for removing ECS instances from the scaling group. Valid values: OldestInstance: removes the ECS… | | ActiveScalingConfigurationId | string | no | The ID of the active scaling configuration in the scaling group | | HealthCheckType | string | no | The health check mode of the scaling group. Valid values: NONE: Health checks are disabled. ECS: Health checks are performed on instances… | | LaunchTemplateId | string | no | The ID of the launch template from which the scaling group obtains launch configuration information | | LaunchTemplateVersion | string | no | The version of the launch template. Valid values: A fixed template version number. Default: always uses the default version of the… | | OnDemandBaseCapacity | integer | no | The minimum number of pay-as-you-go instances required in the scaling group. Valid values: 0 to 1000. When the number of pay-as-you-go… | | OnDemandPercentageAboveBaseCapacity | integer | no | The percentage of pay-as-you-go instances among the excess instances after the minimum number of pay-as-you-go instances… | | SpotInstanceRemedy | string | no | Specifies whether to supplement spot instances. When this feature is enabled and the scaling group receives a system message that a spot… | | CompensateWithOnDemand | string | no | Specifies whether to automatically create pay-as-you-go instances to meet the required number of ECS instances when spot instances cannot… | | SpotInstancePools | integer | no | The number of available instance types. The scaling group creates spot instances of multiple types at the lowest cost. Valid values: 0 to… | | DesiredCapacity | integer | no | The expected number of ECS instances or elastic container instances in the scaling group. Setting this parameter enables the expected… | | GroupDeletionProtection | string | no | Specifies whether to enable deletion protection for the scaling group. Valid values: true: Deletion protection is enabled. The scaling… | | MultiAZPolicy | string | no | The scaling policy for ECS instances in a multi-zone scaling group. Valid values: PRIORITY: Instances are scaled based on the priority of… | | VSwitchIds | string | no | The IDs of one or more vSwitches. This parameter takes effect only when the network type of the scaling group is VPC. The specified… | | LaunchTemplateOverride | string | no | The launch template override information (JSON-encoded) | | AzBalance | string | no | Specifies whether to evenly distribute the capacity of the scaling group across multiple zones. This parameter takes effect only when the… | | AllocationStrategy | string | no | The capacity allocation strategy that determines how the scaling group selects available instance types to meet capacity requirements. The… | | SpotAllocationStrategy | string | no | The spot capacity allocation strategy. You can use this parameter to separately specify the allocation strategy for spot capacity. This… | | MaxInstanceLifetime | integer | no | The maximum amount of time that an instance can remain in the scaling group. Unit: seconds. Valid values: 0 or `[86400,… | | CustomPolicyARN | string | no | The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function). This parameter takes effect only when the first scale-in… | | DisableDesiredCapacity | string | no | Specifies whether to disable the expected number of instances feature for the scaling group. Valid values: false: Enables the expected… | | ScalingPolicy | string | no | The reclaim mode of the scaling group. Valid values: recycle: The scaling group uses the shutdown and recycle mode. release: The scaling… | | HealthCheckTypes | string | no | The health check modes of the scaling group. You can specify multiple values for this parameter to enable multiple health check options.… | | StopInstanceTimeout | integer | no | The timeout period for waiting for an ECS instance to stop during a scale-in process. Unit: seconds. Valid values: 30 to 240. This… | | CapacityOptions | string | no | The capacity options (JSON-encoded) | | BalanceMode | string | no | The zone balancing mode. This parameter takes effect only when zone balancing is enabled. Valid values: BalancedBestEffort: When resource… | | AutoRebalance | string | no | Specifies whether to enable automatic rebalancing for the scaling group. This parameter takes effect only when BalancedOnly is enabled for… | ### Modifies one or more attributes of a scaling rule. If an existing scaling rule no longer meets your… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-scaling-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingRuleId | string | yes | The ID of the scaling rule | | ScalingRuleName | string | no | The name of the scaling rule. The name must be 2 to 64 characters in length and start with a digit, a letter, or a Chinese character. It… | | Cooldown | integer | no | The cooldown time of the scaling rule. This parameter applies only to simple scaling rules. Valid values: 0 to 86400. Unit: seconds | | MinAdjustmentMagnitude | integer | no | The minimum number of instances to be adjusted. This parameter takes effect only when the scaling rule type is `SimpleScalingRule` or… | | AdjustmentType | string | no | The adjustment method of the scaling rule. This parameter is required when the scaling rule is a simple scaling rule or a step scaling… | | AdjustmentValue | integer | no | The adjustment value of the scaling rule. This parameter is required when the scaling rule is a simple scaling rule or a step scaling… | | EstimatedInstanceWarmup | integer | no | The warmup time of instances. This parameter applies to target tracking scaling rules and step scaling rules. ECS instances in the warmup… | | MetricName | string | no | The predefined metric. This parameter is required when the scaling rule is a target tracking scaling rule or a predictive scaling rule.… | | TargetValue | number | no | The target value. This parameter applies to target tracking scaling rules and predictive scaling rules. The value can have up to three… | | DisableScaleIn | string | no | Specifies whether to disable scale-in. This parameter applies only to target tracking scaling rules | | ScaleInEvaluationCount | integer | no | After a target tracking scaling rule is created, an event-triggered task is automatically created. This parameter specifies the number of… | | ScaleOutEvaluationCount | integer | no | After a target tracking scaling rule is created, an event-triggered task is automatically created. This parameter specifies the number of… | | PredictiveScalingMode | string | no | The mode of the predictive scaling rule. Valid values: PredictAndScale: generates predictions and creates predictive tasks. PredictOnly:… | | PredictiveValueBehavior | string | no | The method to handle the maximum value for the predictive scaling rule. Valid values: MaxOverridePredictiveValue: the initial maximum… | | PredictiveValueBuffer | integer | no | The buffer ratio added to the predicted value. This parameter takes effect only when `PredictiveValueBehavior` is set to… | | PredictiveTaskBufferTime | integer | no | The buffer time before the predictive task is executed. Predictive tasks automatically created by predictive scaling rules are executed on… | | InitialMaxSize | integer | no | The maximum number of instances in the scaling group. This parameter is used together with PredictiveValueBehavior | | StepAdjustment | string | no | The set of step adjustments (JSON-encoded) | | AlarmDimension | string | no | The dimension information associated with the metric. This parameter applies to target tracking scaling rules and is configured when the… | | MetricType | string | no | The metric type. Valid values: system: uses system metrics from CloudMonitor. custom: uses custom metrics reported to CloudMonitor.… | | HybridMonitorNamespace | string | no | The ID of the Hybrid Cloud Monitoring monitoring metrics repository. For more information about how to manage monitoring metrics… | | HybridMetrics | string | no | The Hybrid Cloud Monitoring monitoring metrics settings. For more information about how to configure the settings, see… | | AlarmOptions | string | no | The alert attributes (JSON-encoded) | ### Modifies the information of a scheduled task `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/modify-scheduled-task` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScheduledTaskId | string | yes | The ID of the scheduled task | | ScheduledTaskName | string | no | The name of the scheduled task. The name must be 2 to 64 characters in length and can contain letters, digits, and Chinese characters. It… | | Description | string | no | The description of the scheduled task. The description must be 2 to 200 characters in length | | ScheduledAction | string | no | The unique identifier of the scaling rule to execute. This parameter takes effect only when the scaling method is set to use an existing… | | RecurrenceEndTime | string | no | The end time of the recurrence for the scheduled task. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time… | | LaunchTime | string | no | The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time… | | RecurrenceType | string | no | The recurrence type of the scheduled task. The task can be executed on a daily, weekly, monthly, or cron-based schedule. Valid values:… | | RecurrenceValue | string | no | The value that corresponds to the recurrence type of the scheduled task. If `RecurrenceType` is set to `Daily`, you can specify only one… | | TaskEnabled | string | no | Specifies whether to enable the scheduled task. Valid values: true: enables the scheduled task. false: disables the scheduled task.… | | LaunchExpirationTime | integer | no | The time period during which Auto Scaling retries the execution of a scheduled task after the task fails to be triggered. Unit: seconds.… | | MinValue | integer | no | The minimum number of instances in the scaling group. This parameter takes effect only when the scaling method is set to configure the… | | MaxValue | integer | no | The maximum number of instances in the scaling group. This parameter takes effect only when the scaling method is set to configure the… | | DesiredCapacity | integer | no | The expected number of instances in the scaling group. This parameter takes effect only when the scaling method is set to configure the… | | ScalingGroupId | string | no | The ID of the scaling group whose instance count you want to modify when the scheduled task is triggered. This parameter takes effect only… | | RegionId | string | no | The region ID of the scaling group | ### Rebalances the distribution of ECS instances in a multi-zone scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/rebalance-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | RegionId | string | no | The region ID of the scaling group | ### Extends the wait time of an ECS instance that is suspended after a lifecycle hook is triggered `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/record-lifecycle-action-heartbeat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | lifecycleHookId | string | yes | The ID of the lifecycle hook | | lifecycleActionToken | string | yes | The wait state identifier of the scaling activity. When the instance is in the wait state, you can obtain this identifier from the details… | | heartbeatTimeout | integer | no | The wait time that a lifecycle hook sets for a scaling group activity. After the wait state times out, the default execution policy is… | | RegionId | string | no | The region ID of the scaling group | ### Removes one or more ECS instances from a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/remove-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | RemovePolicy | string | no | The action to take on the ECS instances that are removed. Valid values: recycle: The ECS instance enters the economy mode. > This value… | | DecreaseDesiredCapacity | string | no | Specifies whether to modify the expected number of instances. Valid values: true: After ECS instances are removed from the scaling group,… | | IgnoreInvalidInstance | string | no | Specifies whether to ignore invalid instances when you delete a batch of instances from the scaling group. Valid values: true: Invalid… | | InstanceId | string | yes | The ID of the ECS instance to be removed (JSON-encoded) | | RegionId | string | no | The region ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that… | | StopInstanceTimeout | integer | no | The timeout period for waiting for an ECS instance to be stopped during the scale-in process. Unit: seconds. Valid values: 30 to 240. By… | | LifecycleHookContext | string | no | The context information of the lifecycle hook (JSON-encoded) | ### Resumes an instance refresh task that is in the paused state `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/resume-instance-refresh` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ScalingGroupId | string | yes | The ID of the scaling group | | InstanceRefreshTaskId | string | no | The ID of the instance refresh task | ### Resumes paused scaling processes in a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/resume-processes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a unique value from your client to ensure that the value… | | Process | string | yes | The type of scaling process that you want to resume. Valid values of N: 1 to 100. Valid values: `ScaleIn`: scale-in process. `ScaleOut`:… | | RegionId | string | no | The region ID of the scaling group | ### Rolls back an instance refresh task during execution. If the desired configuration no longer meets your… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/rollback-instance-refresh` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The ID of the region where the scaling group resides | | ScalingGroupId | string | yes | The ID of the scaling group | | InstanceRefreshTaskId | string | no | The ID of the instance refresh task | ### Triggers elastic scaling based on a specified adjustment rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/scale-with-adjustment` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | AdjustmentType | string | yes | The adjustment method of the scaling activity. Valid values: QuantityChangeInCapacity: adds or removes a specified number of ECS… | | AdjustmentValue | integer | yes | The adjustment value of the scaling activity. The number of ECS instances adjusted in a single scaling activity cannot exceed 1000.… | | MinAdjustmentMagnitude | integer | no | The minimum number of instances to adjust in a scaling activity. This parameter takes effect only when `AdjustmentType` is set to… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The value is generated by the… | | SyncActivity | string | no | Specifies whether to synchronously execute the scaling activity. This parameter is valid only for scaling groups that have the expected… | | Overrides | string | no | The override parameters for scale-out in ECI-type scaling groups (JSON-encoded) | | LifecycleHookContext | string | no | The context information of the lifecycle hook (JSON-encoded) | | ActivityMetadata | string | no | The metadata of the scaling activity | | ExecutionMode | string | no | The execution mode. Valid values: None: not specified. Normal scaling is performed. PlanOnly: scaling is not triggered. Only elastic… | ### Enables or disables deletion protection for a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/set-group-deletion-protection` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | GroupDeletionProtection | string | yes | Specifies whether to enable deletion protection for the scaling group. Valid values: true: Enables deletion protection. After deletion… | | ScalingGroupId | string | yes | The ID of the scaling group | | RegionId | string | no | The region ID of the scaling group | ### Sets the health status of an ECS instance in a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/set-instance-health` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | InstanceId | string | yes | The ID of the instance in the scaling group | | HealthStatus | string | yes | The health status that you want to set for the instance. Valid values: Healthy: sets the instance to the healthy state. Unhealthy: sets… | ### Enables or disables protection for one or more ECS instances in a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/set-instances-protection` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ProtectedFromScaleIn | string | yes | Specifies whether to protect the ECS instance from being terminated or removed from the scaling group during a scale-in activity. Valid… | | InstanceId | string | yes | The ID of the ECS instance (JSON-encoded) | ### Refreshes instances in a scaling group when you need to apply a new scaling configuration or update the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/start-instance-refresh` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | ScalingGroupId | string | yes | The ID of the scaling group | | MinHealthyPercentage | integer | no | The minimum percentage of instances that must remain in service in the scaling group during the instance refresh. Valid values: 0 to 100.… | | MaxHealthyPercentage | integer | no | The maximum percentage by which the number of instances in the scaling group can exceed the scaling group capacity during the instance… | | DesiredConfiguration | string | no | The desired configuration for the instance refresh. You cannot specify ScalingConfigurationId, ImageId, LaunchTemplateId, and Containers… | | SkipMatching | string | no | Specifies whether to skip instances that match the desired configuration. The system determines whether an instance matches based on the… | | Checkpoints | string | no | The checkpoints for the refresh task. Specifies that the task is automatically paused for the duration specified by CheckpointPauseTime… | | CheckpointPauseTime | integer | no | The pause duration when a refresh task checkpoint is reached. Unit: minutes. Valid values: 1 to 2880. Default value: 60 | | Strategy | string | no | The execution strategy for the instance refresh task. Valid values: Rolling: The instance refresh task creates new instances and releases… | ### Pauses an instance refresh task. During the execution of an instance refresh task, if you suspect that the… `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/suspend-instance-refresh` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the scaling group | | ScalingGroupId | string | yes | The scaling group ID | | InstanceRefreshTaskId | string | no | The instance refresh task ID | ### Suspends specified scaling processes in a scaling group `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/suspend-processes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | ScalingGroupId | string | yes | The ID of the scaling group | | ClientToken | string | no | The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make… | | Process | string | yes | The type of scaling process to suspend. Valid values of N: 1 to 100. Valid values: ScaleIn: scale-in process. ScaleOut: scale-out process.… | | RegionId | string | no | The region ID of the scaling group | ### Creates and binds tags to a list of specified Auto Scaling resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the resource. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list | | ResourceType | string | yes | The resource type. Only scaling groups are supported. Valid value: scalinggroup | | ResourceId | string | yes | The resource ID. Valid values of N: 1 to 50 (JSON-encoded) | | Tag | string | yes | The tag information of the resource (JSON-encoded) | ### After a tag is unbound, the tag is automatically deleted if it is not bound to any other resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/untag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | yes | The region ID of the resource. You can call https://help.aliyun.com/document_detail/25609.html to query the most recent region list | | ResourceType | string | yes | The type of the resource. Only scaling groups are supported. Set the value to scalinggroup | | All | string | no | Specifies whether to unbind all tags from the resource. This parameter takes effect only if TagKey.N is not set in the request. Valid… | | ResourceId | string | yes | The resource ID. Valid values of N: 1 to 50 (JSON-encoded) | | TagKey | string | no | The tag key of the resource. Valid values of N: 1 to 20 (JSON-encoded) | ### Checks whether Auto Scaling is authorized to operate ECS resources `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/verify-authentication` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | Uid | integer | no | The ID of your Alibaba Cloud account | | OnlyCheck | string | no | Specifies whether to only check the authorization status. Valid values: true: Only checks the authorization status and does not create a… | ### Verifies whether Auto Scaling is activated `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/verify-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | | RegionId | string | no | The ID of the region where you want to use Auto Scaling. Examples: `cn-hangzhou` and `cn-shanghai`. For more information, see… | ### version `POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://ess.ap-southeast-1.aliyuncs.com | ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:aliyun-ess/apply-scaling-group" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Auto Scaling API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-ess/apply-scaling-group with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Auto Scaling API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Auto Scaling itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Auto Scaling API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ess. ### What is the status of the Alibaba Cloud Auto Scaling API? Needs your own provider key (bring your own key)