建立DHCP選項集。
介面說明
- CreateDhcpOptionsSet 介面屬於非同步介面，即系統會返回一個執行個體 ID，但該 DHCP 選項集尚未建立完成，系統背景工作仍在進行中。您可以調用
GetDhcpOptionsSet 查詢 DHCP 選項集的建立狀態：
當交換器處於 Pending 狀態時，表示 DHCP 選項集正在配置中。
當交換器處於 Available 狀態時，表示 DHCP 選項集可用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 個字元，必須以字母或中文開頭，但不能以 |
description |
| DomainName |
string |
否 |
主機名稱尾碼，例如 example.com。 DHCP 選項集關聯 VPC 後，會自動將主機名稱尾碼同步給 VPC 中 ECS 執行個體。 |
example.com |
| ResourceGroupId |
string |
否 |
DHCP 選項集所屬的資源群組 ID。 |
rg-acfmxazb4ph**** |
| Tag |
array<object> |
否 |
資源的標籤。 |
|
|
object |
否 |
標籤。 |
||
| Key |
string |
否 |
資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。 一個標籤鍵最多支援 128 個字元，不能以 |
FinanceDept |
| Value |
string |
否 |
資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。 最多支援 128 個字元，不能以 |
FinanceJoshua |
| ClientToken |
string |
否 |
用戶端 Token，用於保證請求的等冪性。 從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。 |
0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| DryRun |
boolean |
否 |
是否只預檢此次請求，取值： true：發送檢查請求，不會建立 DHCP 選項集。檢查項包括是否填寫了必需參數、請求格式和限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接建立 DHCP 選項集。 |
false |
| LeaseTime |
string |
否 |
IPv4 DHCP 選項集的租賃時間。
說明
輸入參數取值時，必須輸入參數的單位。 |
3650d |
| Ipv6LeaseTime |
string |
否 |
IPv6 DHCP 選項集的租賃時間。
說明
輸入參數取值時，必須輸入參數的單位。 |
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. | 指定的地區不存在。請檢查該參數是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。