All Products
Search
Document Center

Virtual Private Cloud:SwitchActiveRouteTarget

Last Updated:Aug 28, 2026

Switches the active and standby targets in a route target group.

Operation description

Switches the active and standby targets in 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RouteTargetGroupId

string

Yes

The 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 ensures the idempotence of the request. Set this to a unique ASCII string generated by your client. If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId may differ for each API request.

0c593ea1-3bea-11e9-b96b-88e9fe6****

Tag

array<object>

No

Resource tags.

object

No

List of resource tags.

Key

string

No

The tag key. 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. You can specify up to 20 tag values. The tag value can be an empty string and can be up to 128 characters in length. It cannot start with aliyun or acs: and 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.