All Products
Search
Document Center

Virtual Private Cloud:GetRouteTargetGroup

Last Updated:Jan 07, 2026
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get the route target group

Operation description

Get the information of the route target group instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:GetRouteTargetGroupget
*RouteTargetGroup
acs:vpc:{#regionId}:{#accountId}:routetargetgroup/{#RouteTargetGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RouteTargetGroupIdstringYes

ID of the route target group member instance.

rtg-xxxx
RegionIdstringYes

ID of the region to which the route target group belongs. You can obtain the region ID by calling the DescribeRegions interface.

cn-hangzhou
ClientTokenstringNo

Client token, used to ensure idempotence of the request.

Generate a parameter value from your client and ensure that it is unique across different requests. ClientToken only supports ASCII characters.

Note If you do not specify this, the system automatically uses the RequestId of the API request as the ClientToken identifier. The RequestId may be different for each API request.
02fb3da4-130e-11e9-8e44-0016e04115b
Tagarray<object>No

Tag information.

objectNo

Collection of resource tags.

KeystringNo

Resource tag key. Up to 20 tag keys are supported. If you need to pass this value, you cannot input an empty string.

A tag key can have up to 128 characters and cannot start with aliyun or acs:. It cannot contain http:// or https://.

FinanceDept
ValuestringNo

Resource tag value. Up to 20 tag values are supported. If you need to pass this value, you can input an empty string.

A tag value can have up to 128 characters and cannot start with aliyun or acs:. It cannot contain http:// or https://.

FinanceJoshua

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RouteTargetGroupIdstring

ID of the route target group instance.

rtg-xxxx
RouteTargetGroupNamestring

Name of the route target group.

myRouteTargetGroupName
RouteTargetGroupDescriptionstring

Description of the route target group.

myRouteTargetGroupDescription
VpcIdstring

ID of the VPC to which the route target group belongs.

vpc-xxxx
ConfigModestring

Configuration mode of the route target group. Supported modes are as follows:

  • Active-Standby: Active-standby mode.
Active-Standby
Statusstring

Status of the route target group.

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

List of members in the route target group.

RouteTargetMemberListobject
MemberIdstring

ID of the route target group member instance.

ep-xxxx
MemberTypestring

Type of the route target group member.

Currently supported types:

  • GatewayLoadBalancerEndpoint
Enumeration Value:
  • GatewayLoadBalancerEndpoint: 网关型负载均衡终端节点.
GatewayLoadBalancerEndpoint
Weightinteger

Weight value of the route target group member. Values:

  • 100: Indicates the member is the primary instance.
  • 0: Indicates the member is the standby instance.

The weight value can only be set during creation and cannot be modified.

100
HealthCheckStatusstring

Route target group member health check status. Values:

  • Normal: Normal
  • Abnormal: Abnormal
Normal
EnableStatusstring

The enable status of the route target group member. Values:

  • Enable: Enabled.
  • Disable: Disabled.

Only disabled route target group members can be modified to other instances. Enabled route target group members cannot be modified.

Enumeration Value:
  • Enable: 使能中.
  • Disable: 未使能.
Enable
Tagsarray<object>

Tags of the route target group.

Tagobject

Resource tags.

Keystring

Tag key.

FinanceDept
Valuestring

Tag value.

FinanceJoshua
RegionIdstring

The region ID of the VPC to which the route target group belongs. You can obtain the region ID by calling the DescribeRegions interface.

cn-qingdao
RequestIdstring

The request ID.

1AE05898-06E5-4782-xxxxx
ResourceGroupIdstring

The ID of the resource group to which the route target group belongs.

rg-acfmxazdjdhd****
CreateTimestring

The time when the route target group was created.

2025-12-30T06:40:50Z

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.RouteTargetGroupThe specified resource of %s is not found.The specified resource% s does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2026-01-04Add OperationView Change Details