ルートターゲットグループの一括クエリ
操作説明
ルートターゲットグループを一覧表示します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| VpcId |
string |
任意 |
ルートターゲットグループが属する VPC の ID です。 |
vpc-xxxx |
| RouteTargetGroupIds |
array |
任意 |
ルートターゲットグループインスタンス ID のリストです。 一度に最大 50 個のインスタンス ID をクエリできます。 |
|
|
string |
任意 |
ルートターゲットグループインスタンス ID です。 |
rtg-xxxx |
|
| MemberId |
string |
任意 |
ルートターゲットグループメンバーインスタンス ID です。 指定されたメンバーインスタンス ID を含むルートターゲットグループをフィルタリングします。 |
ep-xxxx |
| MaxResults |
integer |
任意 |
ページサイズ。有効値は 1 ~ 50 です。デフォルト値は 50 です。 |
50 |
| NextToken |
string |
任意 |
次のクエリ用のトークンです。値:初回クエリまたは次のクエリがない場合は、このフィールドを入力する必要はありません。次のクエリがある場合は、前回の API 呼び出しで返された NextToken の値を使用してください。 |
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RegionId |
string |
必須 |
ルートターゲットグループが属する VPC のリージョン ID です。DescribeRegions インターフェイスを呼び出すことで、リージョン ID を取得できます。 |
cn-hangzhou |
| ResourceGroupId |
string |
任意 |
リソースグループ ID です。リソースグループの詳細については、「リソースグループとは」をご参照ください。 |
rg-acfmxazdjdhd**** |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアント側で一意のパラメーター値を生成し、異なるリクエスト間での一意性を確保してください。ClientToken は ASCII 文字のみをサポートします。注意:このパラメーターを指定しない場合、システムは自動的に API リクエストの RequestId を ClientToken 識別子として使用します。RequestId は各 API リクエストごとに異なります。 |
123e4567-e89b-12d3-a456-426655440000 |
| Tag |
array<object> |
任意 |
タグのリストです。 |
|
|
object |
任意 |
リソースタグです。 |
||
| Key |
string |
任意 |
リソースタグキーです。最大 20 個のタグキーを指定できます。この値を渡す必要がある場合は、空文字列を入力することはできません。 タグキーは最大 128 文字まで使用でき、 |
FinanceJoshua |
| Value |
string |
任意 |
リソースタグ値です。最大 20 個のタグ値を指定できます。この値を渡す必要がある場合は、空文字列を入力できます。 タグ値は最大 128 文字まで使用でき、 |
FinanceJoshua |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ |
||
| RequestId |
string |
リクエスト ID |
DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6 |
| NextToken |
string |
次のクエリ用のトークンです。値:NextToken が空の場合、次のクエリがないことを示します。NextToken に戻り値がある場合、次のクエリ用のトークンを示します。 |
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| TotalCount |
integer |
リスト内の項目数です。 |
1 |
| RouteTargetGroups |
array<object> |
ルートターゲットグループのリストです。 |
|
|
array<object> |
|||
| Status |
string |
ルートターゲットグループのステータスです。値:
列挙値:
|
Available |
| RouteTargetGroupDescription |
string |
ルートターゲットグループの説明です。 |
myRouteTargetGroupDescription |
| RouteTargetMemberList |
array<object> |
ルートターゲットグループメンバーのリストです。 |
|
|
object |
ルートターゲットグループメンバーのリストです。 |
||
| MemberId |
string |
ルートターゲットグループメンバーインスタンスの ID です。 |
ep-xxxx |
| EnableStatus |
string |
ルートターゲットグループメンバーの有効ステータスです。値:
無効になっているルートターゲットグループメンバーのみ、他のインスタンスに変更できます。有効になっているルートターゲットグループメンバーは変更できません。 列挙値:
|
Enable |
| MemberType |
string |
ルートターゲットグループメンバーのタイプです。 現在サポートされているタイプ:
列挙値:
|
GatewayLoadBalancerEndpoint |
| HealthCheckStatus |
string |
ルートターゲットグループメンバーのヘルスチェックステータスです。値:
列挙値:
|
Normal |
| Weight |
integer |
ルートターゲットグループメンバーの重み値です。値:
重み値は作成時のみ設定可能で、その後変更はできません。 |
100 |
| VpcId |
string |
ルートターゲットグループが属する VPC の ID です。 |
vpc-uf60y8uzhsvbhmuh3l654 |
| RouteTargetGroupId |
string |
ルートターゲットグループインスタンスの ID です。 |
rtg-xxxx |
| ConfigMode |
string |
ルートターゲットグループの構成モードです。サポートされているモードは以下のとおりです:
列挙値:
|
Active-Standby |
| RegionId |
string |
ルートターゲットグループが属する VPC のリージョン ID です。 DescribeRegions インターフェイスを呼び出すことで、リージョン ID を取得できます。 |
cn-hangzhou |
| Tags |
array<object> |
タグ値です。最大 20 個のタグ値を指定できます。この値を渡す必要がある場合は、空文字列を入力できます。 最大 128 文字まで使用できます。値は |
|
|
object |
タグです。 |
||
| Value |
string |
リソースタグの値です。最大 20 個のタグ値を指定できます。この値を渡す必要がある場合は、空文字列を入力できます。最大 128 文字まで使用できます。値は |
8 |
| Key |
string |
リソースタグのキーです。 |
image/upload/cbbec42e0be33abb27babefcbe0397f0 |
| RouteTargetGroupName |
string |
ルートターゲットグループの名前です。 |
myRouteTargetGroupName |
| ResourceGroupId |
string |
ルートターゲットグループが属するリソースグループの ID です。 |
rg-acfm3swh6ta56ri |
| CreateTime |
string |
ルートターゲットグループの作成時刻です。 |
2025-12-30T06:40:50Z |
| MaxResults |
integer |
ページサイズです。 |
50 |
例
成功レスポンス
JSONJSON
{
"RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TotalCount": 1,
"RouteTargetGroups": [
{
"Status": "Available",
"RouteTargetGroupDescription": "myRouteTargetGroupDescription",
"RouteTargetMemberList": [
{
"MemberId": "ep-xxxx",
"EnableStatus": "Enable",
"MemberType": "GatewayLoadBalancerEndpoint",
"HealthCheckStatus": "Normal",
"Weight": 100
}
],
"VpcId": "vpc-uf60y8uzhsvbhmuh3l654",
"RouteTargetGroupId": "rtg-xxxx",
"ConfigMode": "Active-Standby",
"RegionId": "cn-hangzhou",
"Tags": [
{
"Value": "8",
"Key": "image/upload/cbbec42e0be33abb27babefcbe0397f0"
}
],
"RouteTargetGroupName": "myRouteTargetGroupName",
"ResourceGroupId": "rg-acfm3swh6ta56ri",
"CreateTime": "2025-12-30T06:40:50Z"
}
],
"MaxResults": 50
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。