GetDhcpOptionsSet - 查詢已建立的DHCP選項集 - Virtual Private Cloud

調用GetDhcpOptionsSet介面查詢已建立的DHCP選項集。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	要查詢 DHCP 選項集所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。枚舉值： ap-southeast-1 : ap-southeast-1	cn-hangzhou
DhcpOptionsSetId	string	是	要查詢 DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****

返回參數

名稱	類型	描述	樣本值
	object	DHCP 選項集的描述。
DhcpOptionsSetDescription	string	DHCP 選項集的描述。	test
Status	string	DHCP 選項集的狀態。取值： Available：可用。 InUse：使用中。 Deleted：已刪除。 Pending：配置中。	Available
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
DhcpOptionsSetId	string	DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
DhcpOptionsSetName	string	DHCP 選項集的名稱。	test
OwnerId	integer	DHCP 選項集所屬的阿里雲帳號 ID。	283117732402483989
DhcpOptions	object	DHCP 選項配置資訊。
DomainNameServers	string	DNS 伺服器 IP。	192.XX.XX.123
DomainName	string	主機名稱尾碼。	example.com
LeaseTime	string	IPv4 DHCP 選項集的租賃時間。租賃時間設定為小時時：單位：h。取值範圍：24h~1176h，87600h~175200h。預設值：87600h。租賃時間設定為天時：單位：d。取值範圍： 1d~49d，3650d~7300d。預設值：3650d 。	3650d
Ipv6LeaseTime	string	IPv6 DHCP 選項集的租賃時間。租賃時間設定為小時時：單位：h。取值範圍：24h~1176h，87600h~175200h。預設值：24h。租賃時間設定為天時：單位：d。取值範圍： 1d~49d，3650d~7300d。預設值：1d 。	3650d
AssociateVpcs	array<object>	DHCP 選項集關聯的 VPC 的資訊。
	object	DHCP 選項集關聯的 VPC 的資訊。
AssociateStatus	string	DHCP 選項集關聯的 VPC 的狀態。取值： InUse：使用中。 Pending：配置中。	InUse
VpcId	string	DHCP 選項集關聯的 VPC 的 ID。	vpc-eb3b54r6otues4tjj****
ResourceGroupId	string	DHCP 選項集所屬的資源群組 ID。	rg-acfmxazb4ph****
Tags	array<object>	標籤資訊。
	object	標籤資訊。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua
CreationTime	string	建立時間。	2025-08-21 ***

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地區不存在。請檢查該參數是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。