All Products
Search
Document Center

Virtual Private Cloud:UpdateRouteTargetGroup

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.

Update Route Target Group

Operation description

  • The UpdateRouteTargetGroup interface is an asynchronous API, meaning the system will return a request ID, but the route target group has not yet been fully updated, and the system's background update task is still in progress. You can call ListRouteTargetGroup to query the update status of the route target group:
    • When the route target group is in the Updating state, it indicates that the route target group is being created.
    • When the route target group is in the Available, Unavailable, Switched, or Abnormal state, it indicates that the route target group has completed its update.

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:UpdateRouteTargetGroupupdate
*RouteTargetGroup
acs:vpc:{#regionId}:{#accountId}:routetargetgroup/{#RouteTargetGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RouteTargetGroupIdstringYes

The ID of the route target group instance.

rtg-xxx
RouteTargetGroupNamestringNo

The name of the route target group.

The name length should be between 1 and 128 characters, and cannot start with http:// or https://.

myRouteTargetGroupName
RouteTargetGroupDescriptionstringYes

Description of the route target group.

The description length should be between 1 to 256 characters and must not start with http:// or https://.

myRouteTargetGroupDescription
RouteTargetMemberListarray<object>No

List of members in the route target group. Under the primary-standby mode, there are the following restrictions on the members of the route target group:

  1. The number of members in the route target group must be 2.
  2. The members of the route target group must belong to different availability zones.
objectNo
MemberIdstringNo

ID of the route target group member instance.

ep-xxxx
MemberTypestringNo

The member type of the route target group.

Currently supported types: - GatewayLoadBalancerEndpoint

In active-standby mode, all members of the route target group must be of the same type.

GatewayLoadBalancerEndpoint
WeightintegerNo

The weight value of the route target group member. Values:

  • 100: indicates the member is the primary instance.
  • 0: indicates the member is the backup instance. The weight value can only be set during creation and cannot be modified.
100
RegionIdstringYes

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

cn-hangzhou
ClientTokenstringNo

Client Token, used to ensure the idempotence of requests. Generate a unique value for this parameter from your client for each request. ClientToken supports only ASCII characters. Note that if you do not specify this, the system will automatically use the RequestId of the API request as the ClientToken identifier. The RequestId may differ for each API request.

123e4567-e89b-12d3-a456-426655440000

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.RouteTargetGroupThe specified resource of %s is not found.The specified resource% s does not exist.
400IncorrectStatus.RouteTargetGroupThe status of %s [%s] is incorrect.The current state of the RouteTargetGroup prohibits the operation.
400Mismatch.GroupVpcIdAndInstanceVpcIdThe 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.
400OperationDenied.UpdateMemberTypeThe operation is not allowed because of the inability to update memberType.The operation is not allowed because of the inability to update memberType.
400OperationDenied.MemberWithSameAzThe 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.
400OperationDenied.UpdateEnableRouteTargetMemberThe 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.
404ResourceNotFound.GatewayLoadBalancerEndpointGatewayLoadBalancerEndpoint instance not found.GatewayLoadBalancerEndpoint instance not found.

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

Change history

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