動的ホスト構成プロトコル (DHCP) オプションセットをクエリします。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
クエリ対象の DHCP オプションセットが存在するリージョン ID です。 最新のリージョン一覧は、DescribeRegions 操作を呼び出して取得できます。 |
cn-hangzhou |
| NextToken |
string |
任意 |
次のリクエストで新しい結果ページを取得するために使用するページネーショントークンです。有効な値は以下のとおりです。
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
任意 |
1 ページあたりのエントリ数です。有効な値：1～100。デフォルト値：10。 |
10 |
| DomainName |
string |
任意 |
ルートドメインです。たとえば、example.com を設定できます。 DHCP オプションセットが VPC に関連付けられると、その DHCP オプションセット内のルートドメインが自動的に VPC 内の ECS インスタンスに同期されます。 列挙値:
|
example.com |
| DhcpOptionsSetName |
string |
任意 |
DHCP オプションセットの名前です。 名前は 1～128 文字で、英数字、アンダースコア (_)、ハイフン (-) を含めることができます。先頭は英字である必要があります。 有効な値：
列挙値:
|
test |
| DhcpOptionsSetId |
array |
任意 |
DHCP オプションセットの ID です。最大 20 個の ID を指定できます。 |
dopt-o6w0df4epg9zo8isy**** |
|
string |
任意 |
DHCP オプションセットの ID です。最大 20 個の ID を指定できます。 |
dopt-o6w0df4epg9zo8isy**** |
|
| ResourceGroupId |
string |
任意 |
DHCP オプションセットが属するリソースグループの ID です。 |
rg-acfmxazb4ph**** |
| Tags |
array<object> |
任意 |
タグリストです。 |
|
|
object |
任意 |
タグリストです。 |
||
| Key |
string |
任意 |
タグキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。 タグキーの長さは最大 64 文字で、英数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。先頭は英字である必要がありますが、 |
FinanceDept |
| Value |
string |
任意 |
タグ値です。最大で 20 個のタグ値を指定できます。タグ値は空の文字列でもかまいません。 タグ値の長さは最大 128 文字で、数字、ピリオド（.）、アンダースコア（_）、ハイフン（-）を含めることができます。タグ値は英字で始まる必要がありますが、 |
FinanceJoshua |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
次のリクエストで新しい結果ページを取得するために使用するページネーショントークンです。有効な値は以下のとおりです。
|
||
| NextToken |
string |
ページネーショントークンです。次のリクエストで新しい結果ページを取得するために使用できます。有効な値は以下のとおりです。
|
FFmyTO70tTpLG6I3FmYAXGKPd******** |
| RequestId |
string |
リクエスト ID です。 |
0ED8D006-F706-4D23-88ED-E11ED28DCAC0 |
| DhcpOptionsSets |
array<object> |
DHCP オプションセットのリストです。 |
|
|
array<object> |
DHCP オプションセットのリストです。 |
||
| DhcpOptionsSetDescription |
string |
DHCP オプションセットの説明です。 |
test |
| Status |
string |
DHCP オプションセットのステータスです。有効な値：
|
Available |
| DhcpOptionsSetId |
string |
DHCP オプションセットの ID です。 |
dopt-o6w0df4epg9zo8isy**** |
| DhcpOptionsSetName |
string |
DHCP オプションセットの名前です。 |
test |
| AssociateVpcCount |
integer |
DHCP オプションセットが関連付けられている VPC の数です。 |
2 |
| OwnerId |
integer |
DHCP オプションセットが属する Alibaba Cloud アカウントの ID です。 |
253460731706911258 |
| DhcpOptions |
object |
DHCP オプションの詳細です。 |
|
| DomainNameServers |
string |
DNS サーバの IP アドレスです。 |
192.168.XX.XX |
| DomainName |
string |
ホスト名のサフィックスです。 |
example.com |
| LeaseTime |
string |
DHCP オプションセットの IPv4 アドレスのリース時間です。
|
3650d |
| Ipv6LeaseTime |
string |
IPv6 DHCP オプションセットのリース時間です。
|
3650d |
| ResourceGroupId |
string |
DHCP オプションセットが属するリソースグループの ID です。 |
rg-acfmxazb4ph**** |
| Tags |
array<object> |
タグリストです。 |
|
|
object |
タグリストです。 |
||
| Key |
string |
リソースに追加されたタグ N のキーです。 |
FinanceDept |
| Value |
string |
リソースに追加されたタグ N の値です。 |
FinanceJoshua |
| CreationTime |
string |
DHCP オプションセットの作成時刻です。 |
2025-08-21 *** |
| TotalCount |
string |
エントリ数です。 |
10 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | |
| 400 | InvalidRegionId.NotFound | The specified RegionId does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。