GetDhcpOptionsSet - 查询已创建的DHCP选项集 - 专有网络 VPC

调用GetDhcpOptionsSet接口查询已创建的DHCP选项集。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:GetDhcpOptionsSet

get

*DhcpOptionsSet

acs:vpc:{#regionId}:{#accountId}:dhcpoptionsset/{#DhcpOptionsSetId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询 DHCP 选项集所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。枚举值： ap-southeast-1 : ap-southeast-1	cn-hangzhou
DhcpOptionsSetId	string	是	要查询 DHCP 选项集的 ID。	dopt-o6w0df4epg9zo8isy****

返回参数

名称	类型	描述	示例值
	object	DHCP 选项集的描述。
AssociateVpcs	array<object>	DHCP 选项集关联的 VPC 的信息。
	object	DHCP 选项集关联的 VPC 的信息。
AssociateStatus	string	DHCP 选项集关联的 VPC 的状态。取值： InUse：使用中。 Pending：配置中。	InUse
VpcId	string	DHCP 选项集关联的 VPC 的 ID。	vpc-eb3b54r6otues4tjj****
CreationTime	string	创建时间。	2025-08-21 ***
DhcpOptions	object	DHCP 选项配置信息。
DomainName	string	主机名后缀。	example.com
DomainNameServers	string	DNS 服务器 IP。	192.XX.XX.123
Ipv6LeaseTime	string	IPv6 DHCP 选项集的租赁时间。租赁时间设置为小时时：单位：h。取值范围：24h~1176h，87600h~175200h。默认值：24h。租赁时间设置为天时：单位：d。取值范围： 1d~49d，3650d~7300d。默认值：1d 。	3650d
LeaseTime	string	IPv4 DHCP 选项集的租赁时间。租赁时间设置为小时时：单位：h。取值范围：24h~1176h，87600h~175200h。默认值：87600h。租赁时间设置为天时：单位：d。取值范围： 1d~49d，3650d~7300d。默认值：3650d 。	3650d
DhcpOptionsSetDescription	string	DHCP 选项集的描述。	test
DhcpOptionsSetId	string	DHCP 选项集的 ID。	dopt-o6w0df4epg9zo8isy****
DhcpOptionsSetName	string	DHCP 选项集的名称。	test
OwnerId	integer	DHCP 选项集所属的阿里云账号 ID。	283117732402483989
RequestId	string	请求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
ResourceGroupId	string	DHCP 选项集所属的资源组 ID。	rg-acfmxazb4ph****
Status	string	DHCP 选项集的状态。取值： Available：可用。 InUse：使用中。 Deleted：已删除。 Pending：配置中。	Available
Tags	array<object>	标签信息。
	object	标签信息。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua

示例

正常返回示例

JSON格式

{
  "AssociateVpcs": [
    {
      "AssociateStatus": "InUse",
      "VpcId": "vpc-eb3b54r6otues4tjj****"
    }
  ],
  "CreationTime": "2025-08-21 ***",
  "DhcpOptions": {
    "DomainName": "example.com",
    "DomainNameServers": "192.XX.XX.123",
    "Ipv6LeaseTime": "3650d",
    "LeaseTime": "3650d"
  },
  "DhcpOptionsSetDescription": "test",
  "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
  "DhcpOptionsSetName": "test",
  "OwnerId": 283117732402484000,
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "ResourceGroupId": "rg-acfmxazb4ph****",
  "Status": "Available",
  "Tags": [
    {
      "Key": "FinanceDept",
      "Value": "FinanceJoshua"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地域不存在。请检查该参数是否正确。
400	InvalidDhcpOptionsSetId.NotFound	The specified dhcpOptionsSetId does not exist.	DHCP选项集实例不存在，请检查该参数是否正确。

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

变更历史

更多信息，参考变更详情。