AllocateDedicatedHostsRequest (ecs20140526 5.4.5 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.AllocateDedicatedHostsRequest

public class AllocateDedicatedHostsRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes`
`static class`	`AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`actionOnMaintenance` The policy used to migrate the instances deployed on the dedicated host when the dedicated host fails or needs to be repaired online.
`String`	`autoPlacement` Specifies whether to add the dedicated host to the resource pool for automatic deployment.
`String`	`autoReleaseTime` The time when to automatically release the dedicated host.
`Boolean`	`autoRenew` Specifies whether to automatically renew the subscription dedicated host.
`Integer`	`autoRenewPeriod` The auto-renewal duration of the dedicated host.
`String`	`chargeType` The billing method of the dedicated host.
`String`	`clientToken` The client token that is used to ensure the idempotence of the request.
`Float`	`cpuOverCommitRatio` The CPU overcommit ratio.
`String`	`dedicatedHostClusterId` The ID of the dedicated host cluster in which to create the dedicated host.
`String`	`dedicatedHostName` The name of the dedicated host.
`String`	`dedicatedHostType` The dedicated host type.
`String`	`description` The description of the dedicated host.
`Integer`	`minQuantity` The minimum number of dedicated hosts to create.
`AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes`	`networkAttributes`
`String`	`ownerAccount`
`Long`	`ownerId`
`Integer`	`period` The subscription duration of the dedicated host.
`String`	`periodUnit` The unit of the subscription duration of the dedicated host.
`Integer`	`quantity` The number of dedicated hosts that you want to create.
`String`	`regionId` The ID of the region in which to create the dedicated host.
`String`	`resourceGroupId` The ID of the resource group to which to assign the dedicated host.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`List<AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag>`	`tag` The tags to add to the dedicated host.
`String`	`zoneId` The ID of the zone in which to create the dedicated host.

构造器概要

构造器
构造器和说明

AllocateDedicatedHostsRequest()

构造器
构造器和说明
`AllocateDedicatedHostsRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static AllocateDedicatedHostsRequest`	`build(Map<String,?> map)`
`String`	`getActionOnMaintenance()`
`String`	`getAutoPlacement()`
`String`	`getAutoReleaseTime()`
`Boolean`	`getAutoRenew()`
`Integer`	`getAutoRenewPeriod()`
`String`	`getChargeType()`
`String`	`getClientToken()`
`Float`	`getCpuOverCommitRatio()`
`String`	`getDedicatedHostClusterId()`
`String`	`getDedicatedHostName()`
`String`	`getDedicatedHostType()`
`String`	`getDescription()`
`Integer`	`getMinQuantity()`
`AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes`	`getNetworkAttributes()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`Integer`	`getPeriod()`
`String`	`getPeriodUnit()`
`Integer`	`getQuantity()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`List<AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag>`	`getTag()`
`String`	`getZoneId()`
`AllocateDedicatedHostsRequest`	`setActionOnMaintenance(String actionOnMaintenance)`
`AllocateDedicatedHostsRequest`	`setAutoPlacement(String autoPlacement)`
`AllocateDedicatedHostsRequest`	`setAutoReleaseTime(String autoReleaseTime)`
`AllocateDedicatedHostsRequest`	`setAutoRenew(Boolean autoRenew)`
`AllocateDedicatedHostsRequest`	`setAutoRenewPeriod(Integer autoRenewPeriod)`
`AllocateDedicatedHostsRequest`	`setChargeType(String chargeType)`
`AllocateDedicatedHostsRequest`	`setClientToken(String clientToken)`
`AllocateDedicatedHostsRequest`	`setCpuOverCommitRatio(Float cpuOverCommitRatio)`
`AllocateDedicatedHostsRequest`	`setDedicatedHostClusterId(String dedicatedHostClusterId)`
`AllocateDedicatedHostsRequest`	`setDedicatedHostName(String dedicatedHostName)`
`AllocateDedicatedHostsRequest`	`setDedicatedHostType(String dedicatedHostType)`
`AllocateDedicatedHostsRequest`	`setDescription(String description)`
`AllocateDedicatedHostsRequest`	`setMinQuantity(Integer minQuantity)`
`AllocateDedicatedHostsRequest`	`setNetworkAttributes(AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes networkAttributes)`
`AllocateDedicatedHostsRequest`	`setOwnerAccount(String ownerAccount)`
`AllocateDedicatedHostsRequest`	`setOwnerId(Long ownerId)`
`AllocateDedicatedHostsRequest`	`setPeriod(Integer period)`
`AllocateDedicatedHostsRequest`	`setPeriodUnit(String periodUnit)`
`AllocateDedicatedHostsRequest`	`setQuantity(Integer quantity)`
`AllocateDedicatedHostsRequest`	`setRegionId(String regionId)`
`AllocateDedicatedHostsRequest`	`setResourceGroupId(String resourceGroupId)`
`AllocateDedicatedHostsRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`AllocateDedicatedHostsRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`AllocateDedicatedHostsRequest`	`setTag(List<AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag> tag)`
`AllocateDedicatedHostsRequest`	`setZoneId(String zoneId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - networkAttributes
```
@NameInMap(value="NetworkAttributes")
public AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes networkAttributes
```
  - actionOnMaintenance
```
@NameInMap(value="ActionOnMaintenance")
public String actionOnMaintenance
```
    The policy used to migrate the instances deployed on the dedicated host when the dedicated host fails or needs to be repaired online. Valid values:
    - Migrate: The instances are migrated to another physical server and restarted.
      
      If cloud disks are attached to the dedicated host, the default value is Migrate.
    - Stop: The instances are stopped. If the dedicated host cannot be repaired, the instances are migrated to another physical machine and then restarted.
      
      If local disks are attached to the dedicated host, the default value is Stop.
    example:
    Migrate
  - autoPlacement
```
@NameInMap(value="AutoPlacement")
public String autoPlacement
```
    Specifies whether to add the dedicated host to the resource pool for automatic deployment. If you create an ECS instance on a dedicated host without specifying the DedicatedHostId parameter, Alibaba Cloud selects a dedicated host from the resource pool to host the instance. For more information, see Automatic deployment. Valid values:
    - on: adds the dedicated host to the resource pool for automatic deployment.
    - off: does not add the dedicated host to the resource pool for automatic deployment.
    Default value: on.
    
    If you do not want to add the dedicated host to the resource pool for automatic deployment, set this parameter to off.
    
    example:
    off
  - autoReleaseTime
```
@NameInMap(value="AutoReleaseTime")
public String autoReleaseTime
```
    The time when to automatically release the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
    - It must be at least half an hour later than the current time.
    - It must be at most three years later than the current time.
    - If the value of seconds (ss) is not 00, it is automatically set to 00.
    example:
    2019-08-21T12:30:24Z
  - autoRenew
```
@NameInMap(value="AutoRenew")
public Boolean autoRenew
```
    Specifies whether to automatically renew the subscription dedicated host.
    
    The AutoRenew parameter takes effect only when the ChargeType parameter is set to PrePaid.
    
    Default value: false
    example:
    false
  - autoRenewPeriod
```
@NameInMap(value="AutoRenewPeriod")
public Integer autoRenewPeriod
```
    The auto-renewal duration of the dedicated host. The AutoRenewPeriod parameter takes effect and is required only when the AutoRenew parameter is set to true. Valid values:
    
    Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, and 12.
    example:
    1
  - chargeType
```
@NameInMap(value="ChargeType")
public String chargeType
```
    The billing method of the dedicated host. Valid values:
    - PrePaid: subscription. If you set this parameter to PrePaid, make sure that you have sufficient account balance or credits. Otherwise, InvalidPayMethod is returned.
    - PostPaid: pay-as-you-go.
    Default value: PostPaid.
    example:
    PrePaid
  - clientToken
```
@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 token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.
    example:
    123e4567-e89b-12d3-a456-426655440000
  - cpuOverCommitRatio
```
@NameInMap(value="CpuOverCommitRatio")
public Float cpuOverCommitRatio
```
    The CPU overcommit ratio. You can configure CPU overcommit ratios only for the following dedicated host types: g6s, c6s, and r6s. Valid values: 1 to 5.
    
    The CPU overcommit ratio affects the number of available vCPUs on a dedicated host. You can use the following formula to calculate the number of available vCPUs on a dedicated host: Number of available vCPUs = Number of physical CPU cores × 2 × CPU overcommit ratio. For example, the number of physical CPU cores on each g6s dedicated host is 52. If you set the CPU overcommit ratio of a g6s dedicated host to 4, the number of available vCPUs on the dedicated host is 416. For scenarios that have minimal requirements on CPU stability or where CPU load is not heavy, such as development and test environments, you can increase the number of available vCPUs on a dedicated host by increasing the CPU overcommit ratio. This way, you can deploy more ECS instances of the same specifications on the dedicated host and reduce the unit deployment cost.
    example:
    1
  - dedicatedHostClusterId
```
@NameInMap(value="DedicatedHostClusterId")
public String dedicatedHostClusterId
```
    The ID of the dedicated host cluster in which to create the dedicated host.
    example:
    dc-bp12wlf6am0vz9v2****
  - dedicatedHostName
```
@NameInMap(value="DedicatedHostName")
public String dedicatedHostName
```
    The name of the dedicated host. The name must be 2 to 128 characters in length and can contain letters and digits. The name can contain colons (:), underscores (_), periods (.), and hyphens (-).
    example:
    myDDH
  - dedicatedHostType
```
@NameInMap(value="DedicatedHostType")
public String dedicatedHostType
```
    The dedicated host type. You can call the DescribeDedicatedHostTypes operation to query the most recent list of dedicated host types.
    
    This parameter is required.
    example:
    ddh.c5
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
    example:
    This-is-my-DDH
  - minQuantity
```
@NameInMap(value="MinQuantity")
public Integer minQuantity
```
    The minimum number of dedicated hosts to create. Valid values: 1 to 100.
    
    If the number of available dedicated hosts is less than the minimum number of dedicated hosts to create, the dedicated hosts fail to be created.
    
    example:
    2
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - period
```
@NameInMap(value="Period")
public Integer period
```
    The subscription duration of the dedicated host. The Period parameter is required and takes effect only when the ChargeType parameter is set to PrePaid. Valid values:
    - Valid values when the PeriodUnit parameter is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.
    - Valid values when the PeriodUnit parameter is set to Year: 1, 2, 3, 4, and 5.
    example:
    6
  - periodUnit
```
@NameInMap(value="PeriodUnit")
public String periodUnit
```
    The unit of the subscription duration of the dedicated host. Valid values:
    - Month
    - Year
    Default value: Month.
    example:
    Month
  - quantity
```
@NameInMap(value="Quantity")
public Integer quantity
```
    The number of dedicated hosts that you want to create. Valid values: 1 to 100.
    
    Default value: 1.
    example:
    2
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The ID of the region in which to create the dedicated host. You can call the DescribeRegions operation to query the most recent region list.
    
    This parameter is required.
    example:
    cn-hangzhou
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which to assign the dedicated host.
    example:
    rg-bp67acfmxazb4ph***
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - tag
```
@NameInMap(value="Tag")
public List<AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag> tag
```
    The tags to add to the dedicated host.
  - zoneId
```
@NameInMap(value="ZoneId")
public String zoneId
```
    The ID of the zone in which to create the dedicated host.
    
    This parameter is empty by default. If you do not specify a zone, the system selects a zone.
    example:
    cn-hangzhou-f
- 构造器详细资料
  - AllocateDedicatedHostsRequest
```
public AllocateDedicatedHostsRequest()
```
- 方法详细资料
  - build
```
public static AllocateDedicatedHostsRequest build(Map<String,?> map)
                                           throws Exception
```
    抛出:
    
    Exception
  - setNetworkAttributes
```
public AllocateDedicatedHostsRequest setNetworkAttributes(AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes networkAttributes)
```
  - getNetworkAttributes
```
public AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestNetworkAttributes getNetworkAttributes()
```
  - setActionOnMaintenance
```
public AllocateDedicatedHostsRequest setActionOnMaintenance(String actionOnMaintenance)
```
  - getActionOnMaintenance
```
public String getActionOnMaintenance()
```
  - setAutoPlacement
```
public AllocateDedicatedHostsRequest setAutoPlacement(String autoPlacement)
```
  - getAutoPlacement
```
public String getAutoPlacement()
```
  - setAutoReleaseTime
```
public AllocateDedicatedHostsRequest setAutoReleaseTime(String autoReleaseTime)
```
  - getAutoReleaseTime
```
public String getAutoReleaseTime()
```
  - setAutoRenew
```
public AllocateDedicatedHostsRequest setAutoRenew(Boolean autoRenew)
```
  - getAutoRenew
```
public Boolean getAutoRenew()
```
  - setAutoRenewPeriod
```
public AllocateDedicatedHostsRequest setAutoRenewPeriod(Integer autoRenewPeriod)
```
  - getAutoRenewPeriod
```
public Integer getAutoRenewPeriod()
```
  - setChargeType
```
public AllocateDedicatedHostsRequest setChargeType(String chargeType)
```
  - getChargeType
```
public String getChargeType()
```
  - setClientToken
```
public AllocateDedicatedHostsRequest setClientToken(String clientToken)
```
  - getClientToken
```
public String getClientToken()
```
  - setCpuOverCommitRatio
```
public AllocateDedicatedHostsRequest setCpuOverCommitRatio(Float cpuOverCommitRatio)
```
  - getCpuOverCommitRatio
```
public Float getCpuOverCommitRatio()
```
  - setDedicatedHostClusterId
```
public AllocateDedicatedHostsRequest setDedicatedHostClusterId(String dedicatedHostClusterId)
```
  - getDedicatedHostClusterId
```
public String getDedicatedHostClusterId()
```
  - setDedicatedHostName
```
public AllocateDedicatedHostsRequest setDedicatedHostName(String dedicatedHostName)
```
  - getDedicatedHostName
```
public String getDedicatedHostName()
```
  - setDedicatedHostType
```
public AllocateDedicatedHostsRequest setDedicatedHostType(String dedicatedHostType)
```
  - getDedicatedHostType
```
public String getDedicatedHostType()
```
  - setDescription
```
public AllocateDedicatedHostsRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setMinQuantity
```
public AllocateDedicatedHostsRequest setMinQuantity(Integer minQuantity)
```
  - getMinQuantity
```
public Integer getMinQuantity()
```
  - setOwnerAccount
```
public AllocateDedicatedHostsRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public AllocateDedicatedHostsRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPeriod
```
public AllocateDedicatedHostsRequest setPeriod(Integer period)
```
  - getPeriod
```
public Integer getPeriod()
```
  - setPeriodUnit
```
public AllocateDedicatedHostsRequest setPeriodUnit(String periodUnit)
```
  - getPeriodUnit
```
public String getPeriodUnit()
```
  - setQuantity
```
public AllocateDedicatedHostsRequest setQuantity(Integer quantity)
```
  - getQuantity
```
public Integer getQuantity()
```
  - setRegionId
```
public AllocateDedicatedHostsRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public AllocateDedicatedHostsRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public AllocateDedicatedHostsRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public AllocateDedicatedHostsRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setTag
```
public AllocateDedicatedHostsRequest setTag(List<AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag> tag)
```
  - getTag
```
public List<AllocateDedicatedHostsRequest.AllocateDedicatedHostsRequestTag> getTag()
```
  - setZoneId
```
public AllocateDedicatedHostsRequest setZoneId(String zoneId)
```
  - getZoneId
```
public String getZoneId()
```

类 AllocateDedicatedHostsRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

networkAttributes

actionOnMaintenance

autoPlacement

autoReleaseTime

autoRenew

autoRenewPeriod

chargeType

clientToken

cpuOverCommitRatio

dedicatedHostClusterId

dedicatedHostName

dedicatedHostType

description

minQuantity

ownerAccount

ownerId

period

periodUnit

quantity

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

tag

zoneId

构造器详细资料

AllocateDedicatedHostsRequest

方法详细资料

build

setNetworkAttributes

getNetworkAttributes

setActionOnMaintenance

getActionOnMaintenance

setAutoPlacement

getAutoPlacement

setAutoReleaseTime

getAutoReleaseTime

setAutoRenew

getAutoRenew

setAutoRenewPeriod

getAutoRenewPeriod

setChargeType

getChargeType

setClientToken

getClientToken

setCpuOverCommitRatio

getCpuOverCommitRatio

setDedicatedHostClusterId

getDedicatedHostClusterId

setDedicatedHostName

getDedicatedHostName

setDedicatedHostType

getDedicatedHostType

setDescription

getDescription

setMinQuantity

getMinQuantity

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setPeriod

getPeriod

setPeriodUnit

getPeriodUnit

setQuantity

getQuantity

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount