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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

要查询DHCP选项集所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
MaxResults Integer 10

分批次查询时每次显示的条目数。取值范围:1~100,默认值为10

DomainName String example.com

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

DHCP选项集关联VPC后,会自动将主机名后缀同步给VPC中ECS实例。

DhcpOptionsSetName String test

DHCP选项集的名称。

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

Action String ListDhcpOptionsSets

系统规定参数。取值:ListDhcpOptionsSets

DhcpOptionsSetId.N String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。

N的取值为1~20,最多可以输入20个DHCP选项集的ID。

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd********

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

DhcpOptionsSets Array of DhcpOptionsSet

DHCP选项集列表信息。

DhcpOptionsSetDescription String test

DHCP选项集的描述信息。

Status String Available

DHCP选项集的状态。取值:

  • Available:可用。
  • InUse:使用中。
  • Pending:配置中。
  • Deleted:已删除。
DhcpOptionsSetId String dopt-o6w0df4epg9zo8isy****

DHCP选项集的ID。

DhcpOptionsSetName String test

DHCP选项集的名称。

AssociateVpcCount Integer 2

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

OwnerId Long 253460731706911258

DHCP选项集所属的阿里云账号ID。

DhcpOptions Object

DHCP选项配置信息。

DomainNameServers String 192.168.XX.XX

DNS服务器IP。

DomainName String example.com

主机名后缀。

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=10
&DomainName=example.com
&DhcpOptionsSetName=test
&DhcpOptionsSetId=["dopt-o6w0df4epg9zo8isy****"]
&Action=ListDhcpOptionsSets
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDhcpOptionsSetsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd********</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <DhcpOptionsSets>
        <DhcpOptionsSetDescription>test</DhcpOptionsSetDescription>
        <Status>Available</Status>
        <DhcpOptionsSetId>dopt-o6w0df4epg9zo8isy****</DhcpOptionsSetId>
        <DhcpOptionsSetName>test</DhcpOptionsSetName>
        <AssociateVpcCount>2</AssociateVpcCount>
        <OwnerId>253460731706911260</OwnerId>
        <DhcpOptions>
            <DomainNameServers>192.168.XX.XX</DomainNameServers>
            <DomainName>example.com</DomainName>
        </DhcpOptions>
    </DhcpOptionsSets>
</ListDhcpOptionsSetsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd********",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "DhcpOptionsSets" : [ {
    "DhcpOptionsSetDescription" : "test",
    "Status" : "Available",
    "DhcpOptionsSetId" : "dopt-o6w0df4epg9zo8isy****",
    "DhcpOptionsSetName" : "test",
    "AssociateVpcCount" : 2,
    "OwnerId" : 253460731706911260,
    "DhcpOptions" : {
      "DomainNameServers" : "192.168.XX.XX",
      "DomainName" : "example.com"
    }
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.NextToken The specified NextToken is invalid. 指定的NextToken参数不合法,请检查该参数是否正确。
404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定的地域不存在。请检查该参数是否正确。

访问错误中心查看更多错误码。