すべてのプロダクト
Search
ドキュメントセンター

Virtual Private Cloud:GetRouteTargetGroup

最終更新日:Apr 27, 2026

ルートターゲットグループの取得

操作説明

ルートターゲットグループインスタンスの情報を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

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 文字まで使用でき、aliyun または acs: で開始することはできません。http:// または https:// を含んではいけません。

FinanceDept

Value

string

任意

リソースタグ値です。最大 20 個のタグ値を指定できます。この値を渡す必要がある場合は、空文字列を入力してもかまいません。

タグ値は最大 128 文字まで使用でき、aliyun または acs: で開始することはできません。http:// または https:// を含んではいけません。

FinanceJoshua

レスポンスフィールド

フィールド

説明

object

レスポンススキーマ

RouteTargetGroupId

string

ルートターゲットグループインスタンスの ID です。

rtg-xxxx

RouteTargetGroupName

string

ルートターゲットグループの名前です。

myRouteTargetGroupName

RouteTargetGroupDescription

string

ルートターゲットグループの説明です。

myRouteTargetGroupDescription

VpcId

string

ルートターゲットグループが属する VPC の ID です。

vpc-xxxx

ConfigMode

string

ルートターゲットグループの設定モードです。以下のモードがサポートされています。

  • Active-Standby:アクティブ・スタンバイモード

列挙値:

  • Active-Standby :

    Active-Standby

Active-Standby

Status

string

ルートターゲットグループのステータスです。値は以下のとおりです。

  • Recovering:プライマリへの切り戻し中

  • Switched:プライマリとセカンダリが切り替わった状態

  • Available:利用可能

  • Abnormal:セカンダリインスタンスが異常

  • Pending:作成中

  • Switching:プライマリとセカンダリの切り替え中

  • Deleting:削除中

  • Unavailable:プライマリおよびセカンダリインスタンスの両方が異常

列挙値:

  • Recovering :

    Recovering

  • Switched :

    Switched

  • Available :

    Available

  • Abnormal :

    Abnormal

  • Pending :

    Pending

  • Switching :

    Switching

  • Deleting :

    Deleting

  • Unavailable :

    Unavailable

Available

RouteTargetMemberList

array<object>

ルートターゲットグループ内のメンバー一覧です。

object

MemberId

string

ルートターゲットグループメンバーインスタンスの ID です。

ep-xxxx

MemberType

string

ルートターゲットグループメンバーのタイプです。

現在サポートされているタイプ:

  • GatewayLoadBalancerEndpoint

列挙値:

  • GatewayLoadBalancerEndpoint :

    GatewayLoadBalancerEndpoint

GatewayLoadBalancerEndpoint

Weight

integer

ルートターゲットグループメンバーの重み値です。値は以下のとおりです。

  • 100:メンバーがプライマリインスタンスであることを示します。

  • 0:メンバーがスタンバイインスタンスであることを示します。

重み値は作成時のみ設定可能で、その後変更できません。

列挙値:

  • 0 :

    0

  • 100 :

    100

100

HealthCheckStatus

string

ルートターゲットグループメンバーのヘルスチェックステータスです。値は以下のとおりです。

  • Normal:正常

  • Abnormal:異常

列挙値:

  • Normal :

    Normal

  • Abnormal :

    Abnormal

Normal

EnableStatus

string

ルートターゲットグループメンバーの有効化ステータスです。値は以下のとおりです。

  • Enable:有効

  • Disable:無効

無効化されたルートターゲットグループメンバーのみ、他のインスタンスに変更できます。有効化されたメンバーは変更できません。

列挙値:

  • Enable :

    Enable

  • Disable :

    Disable

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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。