創建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 個字符，必須以字母或中文開頭，但不能以 | 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 個字符，不能以 | FinanceDept |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值，可以輸入空字符串。 最多支持 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 |
返回參數
示例
正常返回示例
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參數不合法 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域不存在。請檢查該參數是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-09-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-05-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-03-23 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-11-17 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |