ルートターゲットグループの取得
操作説明
ルートターゲットグループインスタンスの情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST / HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RouteTargetGroupId |
string |
必須 |
ルートターゲットグループメンバーインスタンスの ID です。 |
rtg-xxxx |
| RegionId |
string |
必須 |
ルートターゲットグループが属するリージョンの ID です。DescribeRegions インターフェイスを呼び出すことで、リージョン ID を取得できます。 |
cn-hangzhou |
| ClientToken |
string |
任意 |
べき等性を保証するためのクライアントトークンです。 クライアント側で一意のパラメーター値を生成し、異なるリクエスト間で重複しないようにしてください。ClientToken は ASCII 文字のみをサポートします。 説明
このパラメーターを指定しない場合、システムは API リクエストの RequestId を自動的に ClientToken 識別子として使用します。RequestId は各 API リクエストごとに異なる可能性があります。 |
02fb3da4-130e-11e9-8e44-0016e04115b |
| Tag |
array<object> |
任意 |
タグ情報です。 |
|
|
object |
任意 |
リソースタグのコレクションです。 |
||
| Key |
string |
任意 |
リソースタグキーです。最大 20 個のタグキーを指定できます。この値を渡す必要がある場合は、空文字列を入力しないでください。 タグキーは最大 128 文字まで使用でき、 |
FinanceDept |
| Value |
string |
任意 |
リソースタグ値です。最大 20 個のタグ値を指定できます。この値を渡す必要がある場合は、空文字列を入力してもかまいません。 タグ値は最大 128 文字まで使用でき、 |
FinanceJoshua |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ |
||
| RouteTargetGroupId |
string |
ルートターゲットグループインスタンスの ID です。 |
rtg-xxxx |
| RouteTargetGroupName |
string |
ルートターゲットグループの名前です。 |
myRouteTargetGroupName |
| RouteTargetGroupDescription |
string |
ルートターゲットグループの説明です。 |
myRouteTargetGroupDescription |
| VpcId |
string |
ルートターゲットグループが属する VPC の ID です。 |
vpc-xxxx |
| ConfigMode |
string |
ルートターゲットグループの設定モードです。以下のモードがサポートされています。
列挙値:
|
Active-Standby |
| Status |
string |
ルートターゲットグループのステータスです。値は以下のとおりです。
列挙値:
|
Available |
| RouteTargetMemberList |
array<object> |
ルートターゲットグループ内のメンバー一覧です。 |
|
|
object |
|||
| MemberId |
string |
ルートターゲットグループメンバーインスタンスの ID です。 |
ep-xxxx |
| MemberType |
string |
ルートターゲットグループメンバーのタイプです。 現在サポートされているタイプ:
列挙値:
|
GatewayLoadBalancerEndpoint |
| Weight |
integer |
ルートターゲットグループメンバーの重み値です。値は以下のとおりです。
重み値は作成時のみ設定可能で、その後変更できません。 列挙値:
|
100 |
| HealthCheckStatus |
string |
ルートターゲットグループメンバーのヘルスチェックステータスです。値は以下のとおりです。
列挙値:
|
Normal |
| EnableStatus |
string |
ルートターゲットグループメンバーの有効化ステータスです。値は以下のとおりです。
無効化されたルートターゲットグループメンバーのみ、他のインスタンスに変更できます。有効化されたメンバーは変更できません。 列挙値:
|
Enable |
| Tags |
array<object> |
ルートターゲットグループのタグです。 |
|
|
object |
リソースタグです。 |
||
| Key |
string |
タグキーです。 |
FinanceDept |
| Value |
string |
タグ値です。 |
FinanceJoshua |
| RegionId |
string |
ルートターゲットグループが属する VPC のリージョン ID です。DescribeRegions インターフェイスを呼び出すことで、リージョン ID を取得できます。 |
cn-qingdao |
| RequestId |
string |
リクエスト ID です。 |
1AE05898-06E5-4782-xxxxx |
| ResourceGroupId |
string |
ルートターゲットグループが属するリソースグループの ID です。 |
rg-acfmxazdjdhd**** |
| CreateTime |
string |
ルートターゲットグループの作成時刻です。 |
2025-12-30T06:40:50Z |
例
成功レスポンス
JSONJSON
{
"RouteTargetGroupId": "rtg-xxxx",
"RouteTargetGroupName": "myRouteTargetGroupName",
"RouteTargetGroupDescription": "myRouteTargetGroupDescription",
"VpcId": "vpc-xxxx",
"ConfigMode": "Active-Standby",
"Status": "Available",
"RouteTargetMemberList": [
{
"MemberId": "ep-xxxx",
"MemberType": "GatewayLoadBalancerEndpoint",
"Weight": 100,
"HealthCheckStatus": "Normal",
"EnableStatus": "Enable"
}
],
"Tags": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
],
"RegionId": "cn-qingdao",
"RequestId": "1AE05898-06E5-4782-xxxxx",
"ResourceGroupId": "rg-acfmxazdjdhd****",
"CreateTime": "2025-12-30T06:40:50Z"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ResourceNotFound.RouteTargetGroup | The specified resource of %s is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。