ListDhcpOptionsSets - 查詢已建立的DHCP選項集列表 - Virtual Private Cloud

調用ListDhcpOptionsSets介面查詢已建立的DHCP選項集列表。

調試

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

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	要查詢 DHCP 選項集所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查詢時每次顯示的條目數。取值範圍：1~100，預設值為 10。	10
DomainName	string	否	主機名稱尾碼，例如 example.com。 DHCP 選項集關聯 VPC 後，會自動將主機名稱尾碼同步給 VPC 中 ECS 執行個體。枚舉值： example.com : example.com	example.com
DhcpOptionsSetName	string	否	DHCP 選項集的名稱。名稱長度為 1~128 個字元，以英文大小寫字母或中文開頭，可包含數字、底線（_）和短劃線（-）。枚舉值： tf-testAccVpcDhcpOptionsSets-1585169790614573448 : tf-testAccVpcDhcpOptionsSets-1585169790614573448	test
DhcpOptionsSetId	array	否	DHCP 選項集的 ID。最多支援輸入 20 個 DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
	string	否	DHCP 選項集的 ID。最多支援輸入 20 個 DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
ResourceGroupId	string	否	DHCP 選項集所屬的資源群組 ID。	rg-acfmxazb4ph****
Tags	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd********
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
DhcpOptionsSets	array<object>	DHCP 選項集列表資訊。
	array<object>	DHCP 選項集列表資訊。
DhcpOptionsSetDescription	string	DHCP 選項集的描述資訊。	test
Status	string	DHCP 選項集的狀態。取值： Available：可用。 InUse：使用中。 Pending：配置中。 Deleted：已刪除。	Available
DhcpOptionsSetId	string	DHCP 選項集的 ID。	dopt-o6w0df4epg9zo8isy****
DhcpOptionsSetName	string	DHCP 選項集的名稱。	test
AssociateVpcCount	integer	DHCP 選項集綁定的 VPC 的數量。	2
OwnerId	integer	DHCP 選項集所屬的阿里雲帳號 ID。	253460731706911258
DhcpOptions	object	DHCP 選項配置資訊。
DomainNameServers	string	DNS 伺服器 IP。	192.168.XX.XX
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
ResourceGroupId	string	DHCP 選項集所屬的資源群組 ID。	rg-acfmxazb4ph****
Tags	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua
CreationTime	string	建立時間	2025-08-21 ***
TotalCount	string	列表條目數。	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"
        }
      ],
      "CreationTime": "2025-08-21 ***"
    }
  ],
  "TotalCount": "10"
}

錯誤碼

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

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

變更歷史

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