CreateRouteTargetGroup API reference - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Creates a route target group instance.

Operation description

CreateRouteTargetGroup is an asynchronous operation. After you invoke this operation, the system returns an instance ID, but the route target group instance is not yet created. The creation node continues in the background. You can invoke ListRouteTargetGroup to query the creation status of the routing target group:
- If the routing target group is in the Pending state, the routing target group is being created.
- If the routing target group is in the Available, Unavailable, Switched, or Abnormal state, the routing target group is created.
Active/standby pattern: When you create a routing target group, configure primary and secondary instances that are in different zones and of the same type.
Primary instance: The weight is 100. The primary instance handles all traffic under normal conditions and takes effect when health checks are successful.
Secondary instance: The weight is 0. The secondary instance takes over traffic when the primary instance fails and serves as disaster recovery and backup.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CreateRouteTargetGroup

create

*RouteTargetGroup

acs:vpc:{#regionId}:{#accountId}:routetargetgroup/*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
VpcId	string	Yes	The ID of the VPC to which the route target group belongs.	vpc-xxxx
RouteTargetGroupName	string	No	The name of the route target group. The name must be 1 to 128 characters in length and cannot start with http:// or https://.	myRouteTargetGroupName
RouteTargetGroupDescription	string	No	The description of the route target group. The description must be 1 to 256 characters in length and cannot start with http:// or https://.	myRouteTargetGroupDescription
RouteTargetMemberList	array<object>	Yes	The member list of the route target group. In active/standby mode, the following limits apply to route target group members: The number of route target group members must be 2. The route target group members must be in different zones.
	object	Yes
MemberId	string	Yes	The instance ID of the route target group member.	ep-xxxx
MemberType	string	Yes	The member type of the route target group. Supported type: GatewayLoadBalancerEndpoint In active/standby mode, all members of the route target group must be of the same type.	GatewayLoadBalancerEndpoint
Weight	integer	Yes	The weight of the route target group member. Valid values: 100: The member is the active instance. 0: The member is the standby instance. The weight can only be set during creation and cannot be modified.	100
ConfigMode	string	Yes	The configuration mode of the route target group. Valid values: Active-Standby: active/standby mode.	Active-Standby
RegionId	string	Yes	The region ID of the route target group. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-acfmxazffggds****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value is different for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe6****
Tag	array<object>	No	The tags of the resource.
	object	No	The tags of the resource.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The 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 of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The 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	Schema of Response
RequestId	string	Id of the request	8AA5CE21-2E6A-4530-BDF5-F055849476E6
RouteTargetGroupId	string	The instance ID of the route target group.	rtg-xxxx

Examples

Success response

JSON format

{
  "RequestId": "8AA5CE21-2E6A-4530-BDF5-F055849476E6",
  "RouteTargetGroupId": "rtg-xxxx"
}

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedFeature.RouteTargetGroup	The feature of RouteTargetGroup is not supported.	The feature of RouteTargetGroup is not supported.
400	Mismatch.GroupVpcIdAndInstanceVpcId	The RouteTargetGroup VPC %s and the RouteTargetConfig VPC %s are mismatched.	The VPC to which the route target group belongs is different from the VPC to which the route target configuration instance belongs.
400	OperationDenied.MemberWithSameAz	The operation is not allowed because of all members being in the same availability zone.	The operation is not allowed because of all members being in the same availability zone.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.
400	ResourceNotFound.GatewayLoadBalancerEndpoint	GatewayLoadBalancerEndpoint instance %s not found.
400	QuotaExceeded.RouteTargetGroup	The quota of %s is exceeded, usage %s/%s.	The quota of %s is exceeded, usage %s/%s.
400	OperationDenied.NatGatewayNotSingleAZ	NAT gateway must be in SingleAZ mode.	A route target group only supports NAT gateways of a single AZ type.
400	OperationDenied.NatGatewayIcmpReplyDisabled	NAT gateway ICMP reply is disabled.	The NAT gateway in the route target group must enable the ICMP return function to ensure that ICMP detection packets can be responded to normally.
400	UnsupportedFeature.RouteTargetGroupForNat	This region currently does not support NAT gateways as route target group members.	The region does not support the NAT Gateway as a member of the route target group.
400	ResourceNotFound.NatGatewayVSwitch	The VSwitch information associated with the selected NAT gateway was not found.	VSwitch information associated with the selected NAT gateway was not found.
400	ResourceNotFound.NatGateway	The selected NAT gateway was not found when creating or modifying the route target group.	The selected NAT gateway resource is not discovered when creating or modifying the routing target group.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.