CreateDhcpOptionsSet - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

DHCP オプションセットを作成します。

操作説明

CreateDhcpOptionsSet は非同期操作です。リクエストを送信すると、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。タスクのステータスを確認するには、GetDhcpOptionsSet を呼び出してください。
- vSwitch の状態が Pending の場合、DHCP オプションセットが設定中です。
- vSwitch の状態が Available の場合、DHCP オプションセットが利用可能です。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	DHCP オプションセットが属するリージョンです。最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。	cn-hangzhou
DomainNameServers	string	任意	DNS サーバの IP アドレスです。最大 4 つの DNS サーバ IP アドレスを入力できます。IP アドレスはカンマ (,) で区切ってください。説明 IP アドレスを指定しない場合、Elastic Compute Service (ECS) インスタンスは、Alibaba Cloud がデフォルトで提供する IP アドレス 100.100.2.136 および 100.100.2.138 を使用します。	192.XX.XX.123
DhcpOptionsSetName	string	任意	DHCP オプションセットの名前です。名前は 1～128 文字で、英字、数字、アンダースコア (_)、ハイフン (-) を使用できます。先頭は英字である必要があります。	name
DhcpOptionsSetDescription	string	任意	DHCP オプションセットの説明です。説明は 1～256 文字で、先頭は英字である必要があります。`http://` または `https://` で始めることはできません。	description
DomainName	string	任意	ルートドメインです。たとえば、example.com を設定できます。 DHCP オプションセットを仮想プライベートクラウド (VPC) に関連付けると、DHCP オプションセット内のルートドメインが VPC 内の ECS インスタンスに自動的に同期されます。	example.com
ResourceGroupId	string	任意	DHCP オプションセットが属するリソースグループの ID です。	rg-acfmxazb4ph****
Tag	array<object>	任意	リソースのタグです。
	object	任意
Key	string	任意	リソースに追加するタグ N のキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。	FinanceDept
Value	string	任意	リソースに追加するタグ N の値です。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。タグ値の長さは最大 128 文字です。`http://` または `https://` を含めることはできません。また、`aliyun` または `acs:` で始めることはできません。	FinanceJoshua
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。トークンはクライアント側で生成できますが、異なるリクエスト間で一意であることを保証する必要があります。クライアントトークンには ASCII 文字のみを使用できます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID は各リクエストごとに異なる場合があります。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	任意	実際のリクエストを実行せずにドライランのみを実施するかどうかを指定します。 true：ドライランのみを実施します。システムは、パラメーター値の欠落、リクエスト構文の誤り、サービス制限など、潜在的な問題をチェックします。ドライランに失敗した場合はエラーメッセージが返されます。ドライランに成功した場合は、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実施し、リクエストを送信します。ドライランに成功した場合は、2xx HTTP ステータスコードが返され、操作が実行されます。	false
LeaseTime	string	任意	DHCP オプションセットの IPv4 アドレスのリース時間です。単位を時間にした場合、有効値は 24h～1176h および 87600h～175200h です。デフォルト値は 87600h です。単位を日にした場合、有効値は 1d～49d および 3650d～7300d です。デフォルト値は 3650d です。説明値を入力する際は、必ず単位も指定してください。	3650d
Ipv6LeaseTime	string	任意	DHCP オプションセットの IPv6 アドレスのリース時間です。単位を時間にした場合、有効値は 24h～1176h および 87600h～175200h です。デフォルト値は 87600h です。単位を日にした場合、有効値は 1d～49d および 3650d～7300d です。デフォルト値は 3650d です。説明値を入力する際は、必ず単位も指定してください。	3650d

レスポンスフィールド

フィールド	型	説明	例
	object	作成された DHCP オプションセットの ID です。
DhcpOptionsSetId	string	作成された DHCP オプションセットの ID です。	dopt-o6w0df4epg9zo8isy****
RequestId	string	リクエスト ID です。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
ResourceGroupId	string	DHCP オプションセットが属するリソースグループの ID です。	rg-acfmxazb4ph****

例

成功レスポンス

JSONJSON

{
  "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "ResourceGroupId": "rg-acfmxazb4ph****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	OperationUnsupported.DhcpOptionsSet	The DHCP options set feature in this region is not supported.
400	InvalidDomainNameServers.Malformed	The specified format of DomainNameServers is invalid.
400	QuotaExceeded.DomainNameServers	The maximum number of domain name servers cannot exceed 4.
400	IllegalParam.DomainNameServers	The specified DomainNameServers is invalid.
400	IllegalParam.DomainName	The specified DomainName is invalid.
400	IllegalParam.DhcpOptionsSetName	The specified DhcpOptionsSetName is invalid.
400	IllegalParam.DhcpOptionsSetDescription	The specified DhcpOptionsSetDescription is invalid.
400	QuotaExceeded.RegionDhcpOptionsSet	The quota of dhcpOptionsSet in the region is exceeded.
400	OperationUnsupported.DhcpLeaseTime	The DhcpOptionsSet of this region does not support custom LeaseTime.
400	IllegalParam.LeaseTime	LeaseTime [%s] is illegal.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.

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

変更履歴

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