CreateDhcpOptionsSet - Virtual Private Cloud

建立 DHCP 選項集。

介面說明

CreateDhcpOptionsSet 介面屬於非同步介面，即系統會返回一個執行個體 ID，但該 DHCP 選項集尚未建立完成，系統後台任務仍在進行中。您可以呼叫 GetDhcpOptionsSet 查詢 DHCP 選項集的建立狀態：
- 當交換器處於 Pending 狀態時，表示 DHCP 選項集正在設定中。
- 當交換器處於 Available 狀態時，表示 DHCP 選項集可用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateDhcpOptionsSet

create

*DhcpOptionsSet

acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	DHCP 選項集所在的地域。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
DomainNameServers	string	否	DNS 伺服器 IP。最多傳入 4 個 DNS 伺服器 IP，DNS 伺服器 IP 之間用半形逗號（,）隔開。說明未傳入任何 DNS 伺服器 IP 時，ECS 執行個體預設使用阿里雲提供的 DNS 伺服器 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 後，會自動將主機名稱後綴同步給 VPC 中的 ECS 執行個體。	example.com
ResourceGroupId	string	否	DHCP 選項集所屬的資源群組 ID。	rg-acfmxazb4ph****
Tag	array<object>	否	資源的標籤。
	object	否	標籤。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入空字串。一個標籤鍵最多支援 128 個字元，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或 `https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入空字串。最多支援 128 個字元，不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或 `https://`。	FinanceJoshua
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	否	是否僅預檢此次請求，取值： true：發送檢查請求，不會建立 DHCP 選項集。檢查項目包括是否填寫了必要參數、請求格式和限制。如果檢查未通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 `DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接建立 DHCP 選項集。	false
LeaseTime	string	否	IPv4 DHCP 選項集的租用時間。租用時間設定為小時時：單位：h。取值範圍：24h~1176h，87600h~175200h。預設值：87600h。租用時間設定為天時：單位：d。取值範圍：1d~49d，3650d~7300d。預設值：3650d。說明輸入參數取值時，必須輸入參數的單位。	3650d
Ipv6LeaseTime	string	否	IPv6 DHCP 選項集的租用時間。租用時間設定為小時時：單位：h。取值範圍：24h~1176h，87600h~175200h。預設值：24h。租用時間設定為天時：單位：d。取值範圍：1d~49d，3650d~7300d。預設值：1d。說明輸入參數取值時，必須輸入參數的單位。	3650d

返回參數

名稱	類型	描述	樣本值
	object	建立成功的 DHCP 選項集 ID。
DhcpOptionsSetId	string	建立成功的 DHCP 選項集 ID。	dopt-o6w0df4epg9zo8isy****
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
ResourceGroupId	string	DHCP 選項集所屬的資源群組 ID。	rg-acfmxazb4ph****

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	OperationUnsupported.DhcpOptionsSet	The DHCP options set feature in this region is not supported.	目前區域暫時不支援 DHCP 選項集功能。
400	InvalidDomainNameServers.Malformed	The specified format of DomainNameServers is invalid.	指定的 DomainNameServers 參數格式不正確，請檢查該參數是否正確。
400	QuotaExceeded.DomainNameServers	The maximum number of domain name servers cannot exceed 4.	設定的 DomainNameServers 數量超過 4 個。
400	IllegalParam.DomainNameServers	The specified DomainNameServers is invalid.	指定的 DomainNameServers 參數不合法，請檢查該參數是否正確。
400	IllegalParam.DomainName	The specified DomainName is invalid.	指定的 DomainName 參數不合法，請檢查該參數是否正確。
400	IllegalParam.DhcpOptionsSetName	The specified DhcpOptionsSetName is invalid.	指定的 DhcpOptionsSetName 參數不合法，請檢查該參數是否正確。
400	IllegalParam.DhcpOptionsSetDescription	The specified DhcpOptionsSetDescription is invalid.	指定的 DhcpOptionsSetDescription 參數不合法，請檢查該參數是否正確。
400	QuotaExceeded.RegionDhcpOptionsSet	The quota of dhcpOptionsSet in the region is exceeded.	單一使用者允許建立 DHCP 選項集執行個體數量超過配額。
400	OperationUnsupported.DhcpLeaseTime	The DhcpOptionsSet of this region does not support custom LeaseTime.	該地域的 DhcpOptionsSet 未支援自訂 LeaseTime。
400	IllegalParam.LeaseTime	LeaseTime [%s] is illegal.	指定的 LeaseTime 參數不合法。
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的 RegionId 不存在，請您檢查此產品在該地域是否可用。
400	IllegalParam.Ipv6LeaseTime	Ipv6LeaseTime [%s] is illegal.	指定的 Ipv6LeaseTime 參數無效。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。