Call SwitchActiveRouteTarget to switch active and standby members of a RouteTargetGroup - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

Performs an active/standby switchover for a route target group.

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

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 instance ID of the route target group.	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 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 of the API request as the ClientToken. The RequestId may be different for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe6****
Tag	array<object>	No	The tags of the resource.
	object	No	The list of resource tags.
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	The request ID.	C1221A1F-2ACD-4592-8F27-474E02883159

Examples

Success response

JSON format

{
  "RequestId": "C1221A1F-2ACD-4592-8F27-474E02883159"
}

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	OperationDenied.SwitchToAbnormalMember	The operation is not allowed because of the inability to switch the RouteTargetMember when the disabled member is in an unhealthy state.	The operation is not allowed because of the inability to switch the RouteTargetMember when the disabled member is in an unhealthy state.
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.