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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:UpdateRouteTargetGroup | update | *RouteTargetGroup acs:vpc:{#regionId}:{#accountId}:routetargetgroup/{#RouteTargetGroupId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RouteTargetGroupId | string | Yes | The ID of the route target group instance. | rtg-xxx |
| RouteTargetGroupName | string | No | 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 |
| RouteTargetGroupDescription | string | Yes | 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 |
| RouteTargetMemberList | array<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:
| |
| object | No | |||
| MemberId | string | No | ID of the route target group member instance. | ep-xxxx |
| MemberType | string | No | 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 |
| Weight | integer | No | The weight value of the route target group member. Values:
| 100 |
| RegionId | string | Yes | 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 |
| ClientToken | string | No | 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
Examples
Sample success responses
JSONformat
{
"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. |
| 404 | ResourceNotFound.GatewayLoadBalancerEndpoint | GatewayLoadBalancerEndpoint instance not found. | GatewayLoadBalancerEndpoint instance not found. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2026-01-04 | Add Operation | View Change Details |
