调用ListDhcpOptionsSets接口查询已创建的DHCP选项集列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ListDhcpOptionsSets | get | *DhcpOptionsSet acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/**DhcpOptionsSet acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/{#DhcpOptionsSetId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要查询 DHCP 选项集所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 | 分批次查询时每次显示的条目数。取值范围：1~100，默认值为 10。 | 10 |
| DomainName | string | 否 | 主机名后缀，例如 example.com。 DHCP 选项集关联 VPC 后，会自动将主机名后缀同步给 VPC 中 ECS 实例。 | example.com |
| DhcpOptionsSetName | string | 否 | DHCP 选项集的名称。 名称长度为 1~128 个字符，以英文大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。 枚举值：
| test |
| DhcpOptionsSetId | array | 否 | DHCP 选项集的 ID。最多支持输入 20 个 DHCP 选项集的 ID。 | |
| string | 否 | DHCP 选项集的 ID。最多支持输入 20 个 DHCP 选项集的 ID。 | dopt-o6w0df4epg9zo8isy**** | |
| ResourceGroupId | string | 否 | DHCP 选项集所属的资源组 ID。 | rg-acfmxazb4ph**** |
| Tags | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | 参数NextToken非法. |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域不存在。请检查该参数是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-11-17 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |