GetRouteTargetGroup API reference - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Queries the details of a route target group.

Operation description

Queries the details of a route target group instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RouteTargetGroupId	string	Yes	The ID of the route target group member instance.	rtg-xxxx
RegionId	string	Yes	The region ID of the route target group. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotency of the request. Specify a unique value from your client. The token can contain only 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
Tag	array<object>	No	The tag information.
	object	No	The collection of resource tags.
Key	string	No	The tag key. You can specify up to 20 tag keys. If you specify this parameter, the value cannot be an empty string. A tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The value can be an empty string. A tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response parameters.
RouteTargetGroupId	string	The ID of the route target group instance.	rtg-xxxx
RouteTargetGroupName	string	The name of the route target group.	myRouteTargetGroupName
RouteTargetGroupDescription	string	The description of the route target group.	myRouteTargetGroupDescription
VpcId	string	The ID of the VPC to which the route target group belongs.	vpc-xxxx
ConfigMode	string	The configuration mode of the route target group. Valid values: Active-Standby: active-standby mode. Valid values: Active-Standby : Active-Standby	Active-Standby
Status	string	The status of the route target group. Valid values: Recovering: The system is switching back to the primary instance. Switched: The primary and standby instances have been switched. Available: The route target group is available. Abnormal: The standby instance is abnormal. Pending: The route target group is being created. Switching: The primary and standby instances are being switched. Deleting: The route target group is being deleted. Unavailable: Both the primary and standby instances are abnormal. Valid values: Recovering : Recovering Switched : Switched Available : Available Abnormal : Abnormal Pending : Pending Switching : Switching Deleting : Deleting Unavailable : Unavailable	Available
RouteTargetMemberList	array<object>	The members of the route target group.
	object
MemberId	string	The ID of the route target group member instance.	ep-xxxx
MemberType	string	The type of the route target group member. Valid values: GatewayLoadBalancerEndpoint Valid values: GatewayLoadBalancerEndpoint : GatewayLoadBalancerEndpoint	GatewayLoadBalancerEndpoint
Weight	integer	The weight of the route target group member. Valid values: 100: The member is the primary instance. 0: The member is the standby instance. The weight can only be set during creation and cannot be modified afterwards. Valid values: 0 : 0 100 : 100	100
HealthCheckStatus	string	The health check status of the route target group member. Valid values: Normal: The member is healthy. Abnormal: The member is unhealthy. Valid values: Normal : Normal Abnormal : Abnormal	Normal
EnableStatus	string	The enabled status of the route target group member. Valid values: Enable: The member is enabled. Disable: The member is disabled. You can replace a route target group member only when it is disabled. Valid values: Enable : Enable Disable : Disable	Enable
Tags	array<object>	The tags of the route target group.
	object	The resource tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
RegionId	string	The region ID of the route target group. You can call the DescribeRegions operation to query the region ID.	cn-qingdao
RequestId	string	The request ID.	1AE05898-06E5-4782-xxxxx
ResourceGroupId	string	The ID of the resource group to which the route target group belongs.	rg-acfmxazdjdhd****
CreateTime	string	The time when the route target group was created.	2025-12-30T06:40:50Z

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	ResourceNotFound.RouteTargetGroup	The specified resource of %s is not found.	The specified resource% s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.