调用CreateDhcpOptionsSet创建DHCP选项集_专有网络VPC(VPC)-阿里云帮助中心

创建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。默认值：87600h。租赁时间设置为天时：单位：d。取值范围： 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****

示例

正常返回示例

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 入参发生变更	查看变更详情