ModifyDhcpOptionsSetAttributes

1. API Description

This API is used to edit the configuration information of a DHCP options set.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

dhcpOptionsSetId

Yes

String

DHCP options set ID.

dhcpOptionsSetName

No

String

Name of the DHCP options set.

The length must be between 1 and 64 characters.

domainNameServers

No

String

DNS server IP.

Up to 4 DNS server IPv4s can be passed in, separated by a comma (,).

ipv6DomainNameServers

No

String

DNS server IP.

Up to 4 DNS server IPv6s can be passed in, separated by a comma (,).

leaseTime

No

String

Lease duration for the IPv4 DHCP options set.

Unit: h.

Value range: 24 - 1176 or 87600 - 175200.

ipv6LeaseTime

No

String

Lease duration for the IPv6 DHCP options set.

Unit: h.

Value range: 24 - 1176 or 87600 - 175200.

description

No

String

DHCP options set description information.

The length is up to 255 characters.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Edit configuration information of a DHCP options set.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyDhcpOptionsSetAttributes
<Common Request Params>

Request:
{
  "dhcpOptionsSetId": "dhcpOptionsSetId1",
  "dhcpOptionsSetName": "dhcpOptionsSetName1",
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code
Error Code
Description

400

INVALID_DHCP_OPTIONS_SET_IP_DUPLICATE

Duplicate IP in the DHCP options set.

400

INVALID_DHCP_OPTIONS_SET_IP_LIMIT

The number of IPs in the DHCP options set exceeds the limit.

400

INVALID_DHCP_OPTIONS_SET_LEASE_TIME

Invalid lease duration format for the DHCP options set.

404

INVALID_DHCP_OPTIONS_SET_NOT_FOUND

The DHCP options set is not found.

400

INVALID_IP_FORMAT

Invalid IP format.

Last updated