Call the UpdateRouteTargetGroup API - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Updates the information of a route target group instance, including the name, description, and disabled members.

Operation description

UpdateRouteTargetGroup is an asynchronous operation. After you send a request, the system returns a request ID, but the route target group has not been updated yet. The update task is still running in the background. You can call ListRouteTargetGroup to query the update status of the route target group:
- If the route target group is in the Updating state, the route target group is being updated.
- If the route target group is in the Available, Unavailable, Switched, or Abnormal state, the route target group has been updated.

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

update

*RouteTargetGroup

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

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RouteTargetGroupId	string	Yes	The routing target group instance ID.	rtg-xxx
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>	No	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 belong to different zones.
	object	No
MemberId	string	No	The instance ID of the route target group member.	ep-xxxx
MemberType	string	No	The member type of the route target group. Currently supported type: GatewayLoadBalancerEndpoint In active/standby mode, all members of the route target group must be of the same type.	GatewayLoadBalancerEndpoint
Weight	integer	No	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
RegionId	string	Yes	The region ID of the route target group instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
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 may be different for each API request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	0ED8D006-F706-4D23-88ED-E11ED28DCAC

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC"
}

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.
400	IncorrectStatus.RouteTargetGroup	The status of %s [%s] is incorrect.	The current state of the RouteTargetGroup prohibits the operation.
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.UpdateMemberType	The operation is not allowed because of the inability to update memberType.	The operation is not allowed because of the inability to update memberType.
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	OperationDenied.UpdateEnableRouteTargetMember	The operation is not allowed because of the inability to update the RouteTargetMember when it is in the enabled state.	The operation is not allowed because of the inability to update the RouteTargetMember when it is in the enabled state.
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	OperationDenied.NatGatewayNotSingleAZ	NAT gateway must be in SingleAZ mode.	A route target group only supports NAT gateways of a single AZ type.
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.
404	ResourceNotFound.GatewayLoadBalancerEndpoint	GatewayLoadBalancerEndpoint instance not found.	GatewayLoadBalancerEndpoint instance not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.