AllocateDedicatedHosts - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

従量課金またはサブスクリプションの専用ホストを作成します。専用ホストは、単一のテナント専用の物理サーバです。専用ホスト上に Elastic Compute Service (ECS) インスタンスを作成し、専用ホストの属性を表示できます。

操作説明

専用ホストを作成する前に、DescribeAvailableResource 操作を呼び出して、特定のリージョンまたはゾーンで利用可能なリソースをクエリできます。

専用ホストを作成する前に、リソースの支払い方法を理解することを推奨します。作成された専用ホストが使用するリソースに対して課金されます。詳細については、「課金概要」をご参照ください。

一度に最大 100 台の従量課金またはサブスクリプションの専用ホストを作成できます。
専用ホストが作成された後、返された専用ホスト ID をリクエストパラメーターの値として使用して DescribeDedicatedHosts 操作を呼び出し、専用ホストの状態をクエリできます。
専用ホストの作成リクエストを送信した後、特定のパラメーターが無効であるか、リクエストされたリソースが不十分な場合、エラーが返されます。エラーの原因の詳細については、このトピックの「エラーコード」セクションをご参照ください。
専用ホストが作成された後、ModifyInstanceDeployment 操作を呼び出して、ECS インスタンスを共有ホストから専用ホストに移行できます。また、別の専用ホストから作成された専用ホストに ECS インスタンスを移行することもできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:AllocateDedicatedHosts

create

*DedicatedHost

acs:ecs:{#regionId}:{#accountId}:ddh/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	専用ホストを作成するリージョンの ID。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
Tag	array<object>	任意	専用ホストに追加するタグ。
	object	任意	専用ホストに追加するタグ。
Key	string	任意	専用ホストに追加するタグ N のキー。N の有効値：1～20。タグキーは空の文字列にできません。タグキーは最大 128 文字で、`http://` または `https://` を含めることはできません。タグキーは acs: または aliyun で始めることはできません。	Environment
Value	string	任意	専用ホストに追加するタグ N の値。N の有効値：1～20。タグ値は空の文字列にできます。タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。	Production
ResourceGroupId	string	任意	専用ホストを割り当てるリソースグループの ID。	rg-bp67acfmxazb4ph***
ZoneId	string	任意	専用ホストを作成するゾーンの ID。このパラメーターはデフォルトで空です。ゾーンを指定しない場合、システムがゾーンを選択します。	cn-hangzhou-f
DedicatedHostName	string	任意	専用ホストの名前。名前は 2～128 文字で、文字と数字を含めることができます。コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることもできます。	myDDH
DedicatedHostClusterId	string	任意	専用ホストを作成する専用ホストクラスターの ID。	dc-bp12wlf6am0vz9v2****
DedicatedHostType	string	必須	専用ホストタイプ。DescribeDedicatedHostTypes 操作を呼び出して、最新の専用ホストタイプのリストをクエリできます。	ddh.c5
ActionOnMaintenance	string	任意	専用ホストに障害が発生した場合、またはオンラインで修復する必要がある場合に、専用ホストにデプロイされたインスタンスを移行するためのポリシー。有効値： Migrate：インスタンスは別の物理マシンに移行されてから再起動されます。クラウドディスクが専用ホストにアタッチされている場合、デフォルト値は Migrate です。 Stop：インスタンスは停止されます。専用ホストが修復できない場合、インスタンスは別の物理マシンに移行されてから再起動されます。ローカルディスクが専用ホストにアタッチされている場合、デフォルト値は Stop です。	Migrate
NetworkAttributes.SlbUdpTimeout	integer	任意	Server Load Balancer (SLB) インスタンスと専用ホスト間の UDP セッションのタイムアウト期間。単位：秒。有効値：15～310。	60
NetworkAttributes.UdpTimeout	integer	任意	ユーザーと専用ホスト上の Alibaba Cloud サービス間の UDP セッションのタイムアウト期間。単位：秒。有効値：15～310。	60
Description	string	任意	専用ホストの説明。説明は 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。	This-is-my-DDH
AutoPlacement	string	任意	専用ホストを自動デプロイ用のリソースプールに追加するかどうかを指定します。DedicatedHostId パラメーターを指定せずに専用ホスト上に ECS インスタンスを作成すると、Alibaba Cloud はリソースプールから専用ホストを選択してインスタンスをホストします。詳細については、「自動デプロイ」をご参照ください。有効値： on：専用ホストを自動デプロイ用のリソースプールに追加します。 off：専用ホストを自動デプロイ用のリソースプールに追加しません。デフォルト値：on。説明専用ホストを自動デプロイ用のリソースプールに追加したくない場合は、このパラメーターを off に設定してください。	off
CpuOverCommitRatio	number	任意	CPU オーバーコミット率。CPU オーバーコミット率は、g6s、c6s、r6s の専用ホストタイプでのみ設定できます。有効値：1～5。 CPU オーバーコミット率は、専用ホストで利用可能な vCPU の数に影響します。次の数式を使用して、専用ホストで利用可能な vCPU の数を計算できます：利用可能な vCPU の数 = 物理 CPU コアの数 × 2 × CPU オーバーコミット率。たとえば、各 g6s 専用ホストの物理 CPU コアの数は 52 です。g6s 専用ホストの CPU オーバーコミット率を 4 に設定すると、専用ホストで利用可能な vCPU の数は 416 になります。CPU の安定性に対する要件が最小限であるか、CPU 負荷が重くないシナリオ (テスト環境など) では、CPU オーバーコミット率を上げることで、専用ホストで利用可能な vCPU の数を増やすことができます。これにより、同じ仕様の ECS インスタンスをより多く専用ホストにデプロイし、ユニットあたりのデプロイメントコストを削減できます。	1
MinQuantity	integer	任意	作成する専用ホストの最小数。有効値：1～100。説明利用可能な専用ホストの数が作成する専用ホストの最小数より少ない場合、専用ホストの作成は失敗します。	2
ChargeType	string	任意	専用ホストの支払い方法。有効値： PrePaid：サブスクリプション。このパラメーターを PrePaid に設定する場合は、アカウントの残高またはクレジットが十分であることを確認してください。そうでない場合、`InvalidPayMethod` が返されます。 PostPaid：従量課金。デフォルト値：PostPaid。	PrePaid
Quantity	integer	任意	作成する専用ホストの数。有効値：1～100。デフォルト値：1。	2
Period	integer	任意	専用ホストのサブスクリプション期間。`Period` パラメーターは必須であり、`ChargeType` パラメーターが `PrePaid` に設定されている場合にのみ有効です。有効値： PeriodUnit パラメーターが Month に設定されている場合の有効値：1、2、3、4、5、6、7、8、9、12、24、36、48、60。 PeriodUnit パラメーターが Year に設定されている場合の有効値：1、2、3、4、5。	6
PeriodUnit	string	任意	専用ホストのサブスクリプション期間の単位。有効値： Month Year デフォルト値：Month。	Month
AutoRenew	boolean	任意	サブスクリプションの専用ホストを自動更新するかどうかを指定します。説明 AutoRenew パラメーターは、ChargeType パラメーターが PrePaid に設定されている場合にのみ有効です。デフォルト値：false	false
AutoRenewPeriod	integer	任意	専用ホストの自動更新期間。AutoRenewPeriod パラメーターは、AutoRenew パラメーターが true に設定されている場合にのみ有効で、必須です。有効値： PeriodUnit が Month に設定されている場合の有効値：1、2、3、6、12。	1
AutoReleaseTime	string	任意	専用ホストを自動的にリリースする時刻。時刻は `ISO 8601` 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は協定世界時 (UTC) である必要があります。説明現在時刻より少なくとも 30 分後である必要があります。現在時刻より最大 3 年後である必要があります。秒 (ss) の値が 00 でない場合、自動的に 00 に設定されます。	2019-08-21T12:30:24Z
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。token は ASCII 文字のみを含み、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	E2A664A6-2933-4C64-88AE-5033D003****
DedicatedHostIdSets	object
DedicatedHostId	array	専用ホスト ID のリスト。
	string	専用ホスト ID。	dh-bp67acfmxazb4d****
OrderId	string	注文 ID。説明このパラメーターは、専用ホストがサブスクリプションタイプ (リクエストパラメーター ChargeType が PrePaid に設定されている) の場合にのみ戻り値を持ちます。	23841229****

例

成功レスポンス

JSONJSON

{
  "RequestId": "E2A664A6-2933-4C64-88AE-5033D003****",
  "DedicatedHostIdSets": {
    "DedicatedHostId": [
      "dh-bp67acfmxazb4d****"
    ]
  },
  "OrderId": "23841229****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidInstanceType.ValueUnauthorized	The specified InstanceType is not authorized.
400	InvalidDescription.Malformed	The specified parameter "Description" is not valid.
400	InvalidParameter.Conflict	The specified region and cluster do not match.
400	InvalidAutoRenewPeriod.ValueNotSupported	The specified autoRenewPeriod is not valid.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.
400	InvalidDedicatedHostType.ValueNotSupported	%s
400	RegionUnauthorized	%s
400	Zone.NotOnSale	%s
400	OperationDenied	The specified DedicatedHostType or Zone is not available or not authorized.
400	InvalidPeriodUnit.ValueNotSupported	The specified parameter PeriodUnit is not valid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.
400	QuotaExceed.AfterpayDedicatedHost	The maximum number of Pay-As-You-Go DedicatedHosts is exceeded: %s
400	InvalidChargeType.ValueNotSupported	ChargeType is not valid
400	InvalidParameter.SlbUdpTimeout	The specified value is invalid.
400	InvalidParameter.UdpTimeout	The specified value is invalid.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
400	InvalidParameter.Quantity	The specified Quantity is invalid.
400	InvalidDedicatedHostPrice.NotFound	The specified Dedicated price is not found.
400	InvalidDedicatedHostType.CpuOverCommitRatioNotSupported	%s
400	InvalidCpuOverCommitRatio.ValueNotSupported	%s
500	InternalError	The request processing has failed due to some unknown error.
403	OperationDenied	The creation of Host to the specified Zone is not allowed.
403	OperationDenied.NoStock	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.
403	NodeControllerUnavailable	The Node Controller is temporarily unavailable.
403	InvalidParameter.ResourceOwnerAccount	ResourceOwnerAccount is Invalid.
403	InvalidUserData.Forbidden	User not authorized to input the parameter "UserData", please apply for permission "UserData"
403	Zone.NotOpen	The specified zone is not granted to you to buy resources yet.
403	Zone.NotOnSale	The specified zone is not available for purchase.
403	InvalidResourceType.NotSupported	%s
403	InvalidDedicatedHostType.ValueNotSupported	The specified DedicatedHostType does not exist or beyond the permitted range.
403	InvalidDedicatedHostType.ZoneNotSupported	The specified zone does not support this dedicatedHostType.
403	InvalidUserData.Base64FormatInvalid	The specified UserData is not valid
403	InvalidParameter.NotMatch	%s
403	Account.Arrearage	Your account has been in arrears.
404	OperationDenied.NoStock	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.
404	OperationDenied	Another Host has been creating
404	PaymentMethodNotFound	No payment method has been registered on the account.
404	InvalidDedicatedHostName.Malformed	The specified parameter DedicatedHostName is not valid.
404	InvalidDedicatedHostClusterId.NotFound	The specified DedicatedHostClusterId does not exist.
404	InvalidDedicatedHostClusterId.ExceedMaxSize	The specified Dedicated Host Cluster exceeded max capacity.
404	InvalidParameter.ActionOnMaintenance	The specified ActionOnMaintenance does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。