DescribeDhcpOptionsSets

1. API Description

This API is used to query the list of DHCP option sets that have been created.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
dhcpOptionsSetIds	No	Array of String	ID list of the DHCP options sets. Up to 20 IDs of DHCP options sets can be entered.
dhcpOptionsSetName	No	String	Name list of the DHCP options sets. This field supports fuzzy search.
subnetId	No	String	Associated subnet ID.
pageSize	No	Integer	The returned page size. Default value: 20; Maximum value: 1000. Available range: [1, 1000].
pageNum	No	Integer	Number of pages returned. Default value: 1. Available range: [1, +).
resourceGroupId	No	String	Filter by resource group ID.
tagKeys	No	Array of String	Search by tag key. You can query up to 20 tag keys in each request.
Tags	No	Array of Tag	Search by tag. You can query up to 20 tags in each request.

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.
totalCount	Integer	Number of disks meeting the filtering conditions.
dataSet	Array of DhcpOptionsSet	Data for the list of DHCP options sets.

4. Code Example

Example

Query the list of DHCP option sets created.

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

Request：
{
  "dhcpOptionsSetName": "dhcpOptionsSetName1",
  "pageSize": 10,
  "pageNum": 1
}

Response：
{
  "dataSet": [
    {
      "createTime": "2025-12-31T06:35:42Z",
      "description": "",
      "dhcpOptionsSetId": "dhcpOptionsSetId1",
      "dhcpOptionsSetName": "dhcpOptionsSetName1",
      "domainNameServers": "88.88.88.88",
      "ipv6DomainNameServers": "2001:2:0:e344:0:2::3",
      "ipv6LeaseTime": "48",
      "leaseTime": "48",
      "resourceGroupId": "resourceGroupId",
      "resourceGroupName": "resourceGroupName"
    }
  ],
  "requestId": "T82F6B775-F09D-4C13-803B-3033DA839659",
  "totalCount": 1
}

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

No error codes related to the API business logic. For other error codes, see Common Error Codes.