调用ListDhcpOptionsSets接口查询已创建的DHCP选项集列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListDhcpOptionsSets

要执行的操作，取值：ListDhcpOptionsSets。

NextToken String 是 caeba0bbb2be03f84eb48b699f0a4883

查询凭证（Token），取值为上一次API调用返回的NextToken参数值。如果没有下一个查询，请不传。
RegionId String 是 cn-hangzhou

要查询DHCP选项集所在的地域。您可以通过调用DescribeRegions接口获取地域ID。

MaxResults Integer 否 50

使用NextToken方式查询时，每次最多返回的结果数。取值范围：1~50。

默认值：50。

DomainName String 否 example.com

主机名后缀，例如example.com。

DHCP选项集关联VPC后，会自动将主机名后缀同步给VPC中ECS实例。
DhcpOptionsSetId.N RepeatList 否 dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。

最多可以传入20个DHCP选项集的ID。
DhcpOptionsSetName String 否 test

DHCP选项集的名称。

名称长度为2~128个字符，以英文大小写字母或中文开头，可包含数字、下划线（_）和连字符（-）。

返回数据

名称 类型 示例值 描述
DhcpOptionsSets Array

DHCP选项集列表。
AssociateVpcCount Integer 2

DHCP选项集绑定的VPC的数量。
DhcpOptions Struct

DHCP选项配置信息。
DomainName String example.com

主机名后缀。
DomainNameServers String 192.xx.xx.123

DNS服务器IP。
DhcpOptionsSetDescription String test

DHCP选项集的描述。

DhcpOptionsSetId String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。
DhcpOptionsSetName String test

DHCP选项集的名称。
OwnerId Long 12345678

DHCP选项集所属账号ID。
Status String Available

DHCP选项集的状态。

  • Available：可用。
  • InUse：使用中。
  • Deleted：已删除。
  • Pending：配置中。
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始Token，NextToken为空说明没有下一个。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDhcpOptionsSets
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<ListDhcpOptionsSetsResponse>
  <DhcpOptionsSets>
        <Status>Available</Status>
        <DhcpOptionsSetId>dopt-o6w0df4epg9zo8isy****</DhcpOptionsSetId>
        <DhcpOptions>
              <DomainNameServers></DomainNameServers>
        </DhcpOptions>
        <OwnerId>119059297981xxxx</OwnerId>
        <DhcpOptionsSetName>df</DhcpOptionsSetName>
        <AssociateVpcCount>0</AssociateVpcCount>
  </DhcpOptionsSets>
  <DhcpOptionsSets>
        <Status>Available</Status>
        <DhcpOptionsSetId>dopt-o6wia340xes2gipi5****</DhcpOptionsSetId>
        <DhcpOptions>
              <DomainName>gfgf.com</DomainName>
              <DomainNameServers>1.xx.xx.1</DomainNameServers>
        </DhcpOptions>
        <OwnerId>119059297981xxxx</OwnerId>
        <DhcpOptionsSetName>new</DhcpOptionsSetName>
        <AssociateVpcCount>0</AssociateVpcCount>
  </DhcpOptionsSets>
  <RequestId>4DAD3F76-2DB8-4336-B847-D7C0446C7952</RequestId>
</ListDhcpOptionsSetsResponse>

JSON 格式 

{
  "DhcpOptionsSets": [
    {
      "Status": "Available",
      "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
      "DhcpOptions": {
        "DomainNameServers": ""
      },
      "OwnerId": "119059297981xxxx",
      "DhcpOptionsSetName": "df",
      "AssociateVpcCount": 0
    },
    {
      "Status": "Available",
      "DhcpOptionsSetId": "dopt-o6wia340xes2gipi5****",
      "DhcpOptions": {
        "DomainName": "gfgf.com",
        "DomainNameServers": "1.xx.xx.1"
      },
      "OwnerId": "119059297981xxxx",
      "DhcpOptionsSetName": "new",
      "AssociateVpcCount": 0
    }
  ],
  "RequestId": "4DAD3F76-2DB8-4336-B847-D7C0446C7952"
}