public class CreateAutoProvisioningGroupRequest
extends com.aliyun.tea.TeaModel
限定符和类型 | 字段和说明 |
---|---|
String |
autoProvisioningGroupName
The name of the auto provisioning group.
|
String |
autoProvisioningGroupType
The delivery type of the auto provisioning group.
|
String |
clientToken
The client token that is used to ensure the idempotence of the request.
|
List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestDataDiskConfig> |
dataDiskConfig
The configs of data disks.
|
String |
defaultTargetCapacityType
The type of supplemental instances.
|
String |
description
The description of the auto provisioning group.
|
String |
excessCapacityTerminationPolicy
Specifies whether to release the removed instances when the real-time capacity of the auto provisioning group exceeds the target capacity and a scale-in event is triggered.
|
Boolean |
hibernationOptionsConfigured
> This parameter is in invitational preview and unavailable for general users.
|
CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchConfiguration |
launchConfiguration |
List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchTemplateConfig> |
launchTemplateConfig
The configurations of launch template.
|
String |
launchTemplateId
The ID of the launch template associated with the auto provisioning group.
|
String |
launchTemplateVersion
The version of the launch template associated with the auto provisioning group.
|
Float |
maxSpotPrice
The maximum price of preemptible instances in the auto provisioning group.
|
String |
minTargetCapacity
The minimum target capacity of the auto provisioning group.
|
String |
ownerAccount |
Long |
ownerId |
String |
payAsYouGoAllocationStrategy
The policy for creating pay-as-you-go instances.
|
String |
payAsYouGoTargetCapacity
The target capacity of pay-as-you-go instances in the auto provisioning group.
|
String |
regionId
The ID of the region in which to create the auto provisioning group.
|
String |
resourceGroupId
The ID of the resource group to which to assign the auto provisioning group.
|
String |
resourceOwnerAccount |
Long |
resourceOwnerId |
String |
spotAllocationStrategy
The policy for creating preemptible instances.
|
String |
spotInstanceInterruptionBehavior
The operation to be performed on the preemptible instance when it is interrupted.
|
Integer |
spotInstancePoolsToUseCount
The number of preemptible instances of the lowest-priced instance type to be created by the auto provisioning group.
|
String |
spotTargetCapacity
The target capacity of preemptible instances in the auto provisioning group.
|
List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestSystemDiskConfig> |
systemDiskConfig
The configs of system disks.
|
Boolean |
terminateInstances
Specifies whether to release instances in the auto provisioning group when the auto provisioning group is deleted.
|
Boolean |
terminateInstancesWithExpiration
Specifies whether to release instances in the auto provisioning group when the auto provisioning group expires.
|
String |
totalTargetCapacity
The total target capacity of the auto provisioning group.
|
String |
validFrom
The time at which to start the auto provisioning group.
|
String |
validUntil
The expiration time of the auto provisioning group.
|
构造器和说明 |
---|
CreateAutoProvisioningGroupRequest() |
@NameInMap(value="LaunchConfiguration") public CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchConfiguration launchConfiguration
@NameInMap(value="AutoProvisioningGroupName") public String autoProvisioningGroupName
The name of the auto provisioning group. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\_), and hyphens (-).
@NameInMap(value="AutoProvisioningGroupType") public String autoProvisioningGroupType
The delivery type of the auto provisioning group. Valid values:
* request: one-time asynchronous delivery. When the auto provisioning group is started, it attempts to asynchronously deliver an instance cluster that meets the target capacity only once. The group does not retry the operation regardless of whether all the instances are delivered.
* instant: one-time synchronous delivery. When the auto provisioning group is started, it attempts to synchronously deliver an instance cluster that meets the target capacity only once. The list of delivered instances and the causes of delivery failures are returned in the response.
* maintain: continuous delivery. When the auto provisioning group is started, it attempts to deliver an instance cluster that meets the target capacity, and monitors the real-time capacity. If the target capacity of the auto provisioning group is not reached, the auto provisioning group continues to create instances until the target capacity is reached.
Default value: maintain.
@NameInMap(value="ClientToken") public String clientToken
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 sure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).
@NameInMap(value="DataDiskConfig") public List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestDataDiskConfig> dataDiskConfig
The configs of data disks.
@NameInMap(value="DefaultTargetCapacityType") public String defaultTargetCapacityType
The type of supplemental instances. When the sum of the `PayAsYouGoTargetCapacity` and `SpotTargetCapacity` values is smaller than the value of `TotalTargetCapacity`, the auto provisioning group creates instances of the specified type to meet the target capacity. Valid values:
* PayAsYouGo: pay-as-you-go instances
* Spot: preemptible instances
Default value: Spot.
@NameInMap(value="Description") public String description
The description of the auto provisioning group.
@NameInMap(value="ExcessCapacityTerminationPolicy") public String excessCapacityTerminationPolicy
Specifies whether to release the removed instances when the real-time capacity of the auto provisioning group exceeds the target capacity and a scale-in event is triggered. Valid values:
* termination: releases the removed instances.
* no-termination: only removes the instances from the auto provisioning group but does not release them.
Default value: no-termination.
@NameInMap(value="HibernationOptionsConfigured") public Boolean hibernationOptionsConfigured
> This parameter is in invitational preview and unavailable for general users.
@NameInMap(value="LaunchTemplateConfig") public List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchTemplateConfig> launchTemplateConfig
The configurations of launch template.
@NameInMap(value="LaunchTemplateId") public String launchTemplateId
The ID of the launch template associated with the auto provisioning group. You can call the [DescribeLaunchTemplates](~~73759~~) operation to query available launch templates. When both the LaunchTemplateId and `LaunchConfiguration.*` parameters are specified, the LaunchTemplateId parameter takes precedence.
@NameInMap(value="LaunchTemplateVersion") public String launchTemplateVersion
The version of the launch template associated with the auto provisioning group. You can call the [DescribeLaunchTemplateVersions](~~73761~~) operation to query the versions of available launch templates.
Default value: the default version of the launch template.
@NameInMap(value="MaxSpotPrice") public Float maxSpotPrice
The maximum price of preemptible instances in the auto provisioning group.
> When both the `MaxSpotPrice` and `LaunchTemplateConfig.N.MaxPrice` parameters are specified, the smaller one of the two parameter values is used.
@NameInMap(value="MinTargetCapacity") public String minTargetCapacity
The minimum target capacity of the auto provisioning group. The value must be a positive integer.
When you specify this parameter, take note of the following items:
- This parameter takes effect only when `AutoProvisioningGroupType` is set to instant.
- If the number of instances that can be created in the current region is smaller than the value of this parameter, the operation cannot be called and no instances are created.
- If the number of instances that can be created in the current region is greater than the value of this parameter, instances can be created based on specified parameters.
@NameInMap(value="OwnerAccount") public String ownerAccount
@NameInMap(value="OwnerId") public Long ownerId
@NameInMap(value="PayAsYouGoAllocationStrategy") public String payAsYouGoAllocationStrategy
The policy for creating pay-as-you-go instances. Valid values:
* lowest-price: cost optimization policy. The auto provisioning group attempts to create instances of the lowest-priced instance type.
* prioritized: priority-based policy. The auto provisioning group attempts to create instances based on the priority specified by the `LaunchTemplateConfig.N.Priority` parameter.
Default value: lowest-price.
@NameInMap(value="PayAsYouGoTargetCapacity") public String payAsYouGoTargetCapacity
The target capacity of pay-as-you-go instances in the auto provisioning group. The value must be smaller than the `TotalTargetCapacity` value.
@NameInMap(value="RegionId") public String regionId
The ID of the region in which to create the auto provisioning group. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
@NameInMap(value="ResourceGroupId") public String resourceGroupId
The ID of the resource group to which to assign the auto provisioning group.
@NameInMap(value="ResourceOwnerAccount") public String resourceOwnerAccount
@NameInMap(value="ResourceOwnerId") public Long resourceOwnerId
@NameInMap(value="SpotAllocationStrategy") public String spotAllocationStrategy
The policy for creating preemptible instances. Valid values:
* lowest-price: cost optimization policy. The auto provisioning group attempts to create instances of the lowest-priced instance type.
* diversified: balanced distribution policy. The auto provisioning group attempts to create instances in zones that are specified in extended configurations and then evenly distribute the instances across the zones.
* capacity-optimized: capacity-optimized distribution policy. The auto provisioning group attempts to create instances that are of the optimal instance types across the optimal zones based on resource availability.
Default value: lowest-price.
@NameInMap(value="SpotInstanceInterruptionBehavior") public String spotInstanceInterruptionBehavior
The operation to be performed on the preemptible instance when it is interrupted. Valid values:
* stop: stops the preemptible instance.
* terminate: releases the preemptible instance.
Default value: terminate.
@NameInMap(value="SpotInstancePoolsToUseCount") public Integer spotInstancePoolsToUseCount
The number of preemptible instances of the lowest-priced instance type to be created by the auto provisioning group. This parameter takes effect when the `SpotAllocationStrategy` parameter is set to `lowest-price`.
The value of SpotInstancePoolsToUseCount must be smaller than the N value specified in `LaunchTemplateConfig.N.*` parameters.
@NameInMap(value="SpotTargetCapacity") public String spotTargetCapacity
The target capacity of preemptible instances in the auto provisioning group. The value must be smaller than the `TotalTargetCapacity` value.
@NameInMap(value="SystemDiskConfig") public List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestSystemDiskConfig> systemDiskConfig
The configs of system disks.
@NameInMap(value="TerminateInstances") public Boolean terminateInstances
Specifies whether to release instances in the auto provisioning group when the auto provisioning group is deleted. Valid values:
* true: releases instances in the auto provisioning group.
* false: retains instances in the auto provisioning group.
Default value: false.
@NameInMap(value="TerminateInstancesWithExpiration") public Boolean terminateInstancesWithExpiration
Specifies whether to release instances in the auto provisioning group when the auto provisioning group expires. Valid values:
* true: releases instances in the auto provisioning group.
* false: only removes instances from the auto provisioning group but does not release them.
Default value: false.
@NameInMap(value="TotalTargetCapacity") public String totalTargetCapacity
The total target capacity of the auto provisioning group. The value must be a positive integer.
The total target capacity of the auto provisioning group must be greater than or equal to the sum of the target capacity of pay-as-you-go instances specified by the `PayAsYouGoTargetCapacity` parameter and the target capacity of preemptible instances specified by the `SpotTargetCapacity` parameter.
@NameInMap(value="ValidFrom") public String validFrom
The time at which to start the auto provisioning group. The period of time between this point in time and the point in time specified by the `ValidUntil` parameter is the effective time period of the auto provisioning group.
Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
By default, an auto provisioning group is started immediately after it is created.
@NameInMap(value="ValidUntil") public String validUntil
The expiration time of the auto provisioning group. The period of time between this point in time and the point in time specified by the `ValidFrom` parameter is the effective time period of the auto provisioning group.
Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
Default value: 2099-12-31T23:59:59Z.
public static CreateAutoProvisioningGroupRequest build(Map<String,?> map) throws Exception
Exception
public CreateAutoProvisioningGroupRequest setLaunchConfiguration(CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchConfiguration launchConfiguration)
public CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchConfiguration getLaunchConfiguration()
public CreateAutoProvisioningGroupRequest setAutoProvisioningGroupName(String autoProvisioningGroupName)
public String getAutoProvisioningGroupName()
public CreateAutoProvisioningGroupRequest setAutoProvisioningGroupType(String autoProvisioningGroupType)
public String getAutoProvisioningGroupType()
public CreateAutoProvisioningGroupRequest setClientToken(String clientToken)
public String getClientToken()
public CreateAutoProvisioningGroupRequest setDataDiskConfig(List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestDataDiskConfig> dataDiskConfig)
public List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestDataDiskConfig> getDataDiskConfig()
public CreateAutoProvisioningGroupRequest setDefaultTargetCapacityType(String defaultTargetCapacityType)
public String getDefaultTargetCapacityType()
public CreateAutoProvisioningGroupRequest setDescription(String description)
public String getDescription()
public CreateAutoProvisioningGroupRequest setExcessCapacityTerminationPolicy(String excessCapacityTerminationPolicy)
public String getExcessCapacityTerminationPolicy()
public CreateAutoProvisioningGroupRequest setHibernationOptionsConfigured(Boolean hibernationOptionsConfigured)
public Boolean getHibernationOptionsConfigured()
public CreateAutoProvisioningGroupRequest setLaunchTemplateConfig(List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchTemplateConfig> launchTemplateConfig)
public List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestLaunchTemplateConfig> getLaunchTemplateConfig()
public CreateAutoProvisioningGroupRequest setLaunchTemplateId(String launchTemplateId)
public String getLaunchTemplateId()
public CreateAutoProvisioningGroupRequest setLaunchTemplateVersion(String launchTemplateVersion)
public String getLaunchTemplateVersion()
public CreateAutoProvisioningGroupRequest setMaxSpotPrice(Float maxSpotPrice)
public Float getMaxSpotPrice()
public CreateAutoProvisioningGroupRequest setMinTargetCapacity(String minTargetCapacity)
public String getMinTargetCapacity()
public CreateAutoProvisioningGroupRequest setOwnerAccount(String ownerAccount)
public String getOwnerAccount()
public CreateAutoProvisioningGroupRequest setOwnerId(Long ownerId)
public Long getOwnerId()
public CreateAutoProvisioningGroupRequest setPayAsYouGoAllocationStrategy(String payAsYouGoAllocationStrategy)
public String getPayAsYouGoAllocationStrategy()
public CreateAutoProvisioningGroupRequest setPayAsYouGoTargetCapacity(String payAsYouGoTargetCapacity)
public String getPayAsYouGoTargetCapacity()
public CreateAutoProvisioningGroupRequest setRegionId(String regionId)
public String getRegionId()
public CreateAutoProvisioningGroupRequest setResourceGroupId(String resourceGroupId)
public String getResourceGroupId()
public CreateAutoProvisioningGroupRequest setResourceOwnerAccount(String resourceOwnerAccount)
public String getResourceOwnerAccount()
public CreateAutoProvisioningGroupRequest setResourceOwnerId(Long resourceOwnerId)
public Long getResourceOwnerId()
public CreateAutoProvisioningGroupRequest setSpotAllocationStrategy(String spotAllocationStrategy)
public String getSpotAllocationStrategy()
public CreateAutoProvisioningGroupRequest setSpotInstanceInterruptionBehavior(String spotInstanceInterruptionBehavior)
public String getSpotInstanceInterruptionBehavior()
public CreateAutoProvisioningGroupRequest setSpotInstancePoolsToUseCount(Integer spotInstancePoolsToUseCount)
public Integer getSpotInstancePoolsToUseCount()
public CreateAutoProvisioningGroupRequest setSpotTargetCapacity(String spotTargetCapacity)
public String getSpotTargetCapacity()
public CreateAutoProvisioningGroupRequest setSystemDiskConfig(List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestSystemDiskConfig> systemDiskConfig)
public List<CreateAutoProvisioningGroupRequest.CreateAutoProvisioningGroupRequestSystemDiskConfig> getSystemDiskConfig()
public CreateAutoProvisioningGroupRequest setTerminateInstances(Boolean terminateInstances)
public Boolean getTerminateInstances()
public CreateAutoProvisioningGroupRequest setTerminateInstancesWithExpiration(Boolean terminateInstancesWithExpiration)
public Boolean getTerminateInstancesWithExpiration()
public CreateAutoProvisioningGroupRequest setTotalTargetCapacity(String totalTargetCapacity)
public String getTotalTargetCapacity()
public CreateAutoProvisioningGroupRequest setValidFrom(String validFrom)
public String getValidFrom()
public CreateAutoProvisioningGroupRequest setValidUntil(String validUntil)
public String getValidUntil()
Copyright © 2023. All rights reserved.