幫助中心
首頁 Virtual Private Cloud 開發參考 API參考 API目錄 路由目標組 GetRouteTargetGroup - 查詢路由目標組

GetRouteTargetGroup - 查詢路由目標組

更新時間：
Copy as MD
產品

擷取路由目標組執行個體資訊。

介面說明

擷取路由目標組執行個體資訊。

調試

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

調試

授權資訊

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

請求文法

POST / HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值
RouteTargetGroupId

string

是

路由目標群組成員執行個體 ID。

rtg-xxxx
RegionId

string

是

路由目標組所屬地區的 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。

cn-hangzhou
ClientToken

string

否

用戶端 Token，用於保證請求的等冪性。

從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。

02fb3da4-130e-11e9-8e44-0016e04115b
Tag

array<object>

否

標籤資訊。

object

否

資源的標籤集合。

Key

string

否

資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。

一個標籤鍵最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

FinanceDept
Value

string

否

資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。

最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

FinanceJoshua

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

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 :

    主備回切中

  • Switched :

    主備已切換

  • Available :

    可用

  • Abnormal :

    備執行個體異常

  • Pending :

    建立中

  • Switching :

    主備切換中

  • Deleting :

    刪除中

  • Unavailable :

    主備執行個體均異常

Available
RouteTargetMemberList

array<object>

路由目標組的成員列表。

object

MemberId

string

路由目標群組成員執行個體 ID。

ep-xxxx
MemberType

string

路由目標組的成員類型。

當前支援的類型：

  • 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 :

    使能中

  • 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

樣本

正常返回樣本

JSON格式

{
  "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 status code

錯誤碼

錯誤資訊

描述
400 ResourceNotFound.RouteTargetGroup The specified resource of %s is not found. 指定資源%s不存在。

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

變更歷史

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

上一篇：ListRouteTargetGroups - 查詢路由目標組列表下一篇：DeleteRouteTargetGroup