首页 专有网络VPC 开发参考 API参考 API目录 路由目标组 GetRouteTargetGroup - 查询路由目标组

GetRouteTargetGroup - 查询路由目标组

更新时间: 2026-01-07 12:04:29

获取路由目标组实例信息。

接口说明

获取路由目标组实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:GetRouteTargetGroupget
*RouteTargetGroup
acs:vpc:{#regionId}:{#accountId}:routetargetgroup/{#RouteTargetGroupId}

请求参数

名称类型必填描述示例值
RouteTargetGroupIdstring

路由目标组成员实例 ID。

rtg-xxxx
RegionIdstring

路由目标组所属地域的 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
02fb3da4-130e-11e9-8e44-0016e04115b
Tagarray<object>

标签信息。

object

资源的标签集合。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

Schema of Response

RouteTargetGroupIdstring

路由目标组实例 ID。

rtg-xxxx
RouteTargetGroupNamestring

路由目标组名称。

myRouteTargetGroupName
RouteTargetGroupDescriptionstring

路由目标组描述。

myRouteTargetGroupDescription
VpcIdstring

路由目标组所属的 VPC 的 ID。

vpc-xxxx
ConfigModestring

路由目标组的配置模式,支持模式如下:

  • Active-Standby: 主备模式。
Active-Standby
Statusstring

路由目标组的状态。取值:

  • Recovering:主备回切中
  • Switched:主备已切换
  • Available:可用
  • Abnormal:备实例异常
  • Pending:创建中
  • Switching:主备切换中
  • Deleting:删除中
  • Unavailable:主备实例均异常
Available
RouteTargetMemberListarray<object>

路由目标组的成员列表。

RouteTargetMemberListobject
MemberIdstring

路由目标组成员实例 ID。

ep-xxxx
MemberTypestring

路由目标组的成员类型。

当前支持的类型:

  • GatewayLoadBalancerEndpoint
枚举值:
  • GatewayLoadBalancerEndpoint网关型负载均衡终端节点
GatewayLoadBalancerEndpoint
Weightinteger

路由目标组成员的权重值。取值:

  • 100:表示成员为主实例。
  • 0:表示成员为备实例。

权重值仅支持在创建时设置,不支持修改。

100
HealthCheckStatusstring

路由目标组成员健康检查状态。取值:

  • Normal:正常
  • Abnormal:状态异常
Normal
EnableStatusstring

路由目标组成员使能状态。取值:

  • Enable:使能中。
  • Disable:未使能。

只有未使能状态的路由目标组成员允许被修改为其他实例。使能中的路由目标组成员禁止修改。

Enable
Tagsarray<object>

路由目标组的标签。

Tagobject

资源的标签。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua
RegionIdstring

路由目标组所属的 VPC 的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-qingdao
RequestIdstring

请求 ID。

1AE05898-06E5-4782-xxxxx
ResourceGroupIdstring

要查询的路由目标组所属资源组的 ID。

rg-acfmxazdjdhd****
CreateTimestring

创建路由目标组的时间。

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错误码错误信息描述
400ResourceNotFound.RouteTargetGroupThe specified resource of %s is not found.指定资源%s不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2026-01-04新增 OpenAPI查看变更详情
上一篇: ListRouteTargetGroups - 查询路由目标组列表 下一篇: DeleteRouteTargetGroup - 删除路由目标组
阿里云首页 专有网络VPC 相关技术圈