全部产品
Search
文档中心

专有网络 VPC:ListDhcpOptionsSets - 查询已创建的DHCP选项集列表

更新时间:Mar 04, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:ListDhcpOptionsSetsRead
  • DhcpOptionsSet
    acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/*
  • DhcpOptionsSet
    acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/{#DhcpOptionsSetId}

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-hangzhou
NextTokenstring

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

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

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

10
DomainNamestring

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

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

example.com
DhcpOptionsSetNamestring

DHCP 选项集的名称。

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

枚举值:
  • tf-testAccVpcDhcpOptionsSets-1585169790614573448tf-testAccVpcDhcpOptionsSets-1585169790614573448
test
DhcpOptionsSetIdarray

DHCP 选项集的 ID。最多支持输入 20 个 DHCP 选项集的 ID。

string

DHCP 选项集的 ID。最多支持输入 20 个 DHCP 选项集的 ID。

dopt-o6w0df4epg9zo8isy****
ResourceGroupIdstring

DHCP 选项集所属的资源组 ID。

rg-acfmxazb4ph****
Tagsobject []

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
NextTokenstring

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd********
RequestIdstring

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0
DhcpOptionsSetsobject []

DHCP 选项集列表信息。

DhcpOptionsSetDescriptionstring

DHCP 选项集的描述信息。

test
Statusstring

DHCP 选项集的状态。取值:

  • Available:可用。

  • InUse:使用中。

  • Pending:配置中。

  • Deleted:已删除。

Available
DhcpOptionsSetIdstring

DHCP 选项集的 ID。

dopt-o6w0df4epg9zo8isy****
DhcpOptionsSetNamestring

DHCP 选项集的名称。

test
AssociateVpcCountinteger

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

2
OwnerIdlong

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

253460731706911258
DhcpOptionsobject

DHCP 选项配置信息。

DomainNameServersstring

DNS 服务器 IP。

192.168.XX.XX
DomainNamestring

主机名后缀。

example.com
LeaseTimestring

IPv4 DHCP 选项集的租赁时间。

  • 租赁时间设置为小时时,单位:h。取值范围:24h~1176h87600h~175200h。 默认值:87600h

  • 租赁时间设置为天时,单位:d。取值范围: 1d~49d3650d~7300d。 默认值:3650d

3650d
Ipv6LeaseTimestring

IPv6 DHCP 选项集的租赁时间。

  • 租赁时间设置为小时时,单位:h。取值范围:24h~1176h87600h~175200h。 默认值:87600h

  • 租赁时间设置为天时,单位:d。取值范围: 1d~49d3650d~7300d。 默认值:3650d

3650d
ResourceGroupIdstring

DHCP 选项集所属的资源组 ID。

rg-acfmxazb4ph****
Tagsobject []

标签列表。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua
TotalCountstring

列表条目数。

10

示例

正常返回示例

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",
        "LeaseTime": "3650d",
        "Ipv6LeaseTime": "3650d"
      },
      "ResourceGroupId": "rg-acfmxazb4ph****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "TotalCount": "10"
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenThe specified NextToken is invalid.参数NextToken非法.
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域不存在。请检查该参数是否正确。

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

变更历史

变更时间变更内容概要操作
2023-03-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
    新增入参:Tags
出参OpenAPI 返回结构发生变更
2021-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更