Performs a failover test.
Operation description
You can perform only failover tests that are in the Pending state.
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:
- The required resource types are displayed in bold characters.
- 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:StartFailoverTestJob | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the failover test. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ClientToken | string | Yes | 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 client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
| JobId | string | Yes | The ID of the failover test. | ftj-xxxxxxxxx |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF\n"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalParam.JobId | The specified parameter JobId is illegal. | The entered failover test job ID is invalid. |
| 400 | IncorrectStatus.OnlyForInit | Only the init status failover test job can be started. | Only the init status failover test job can be started. |
| 400 | EcFailoverTestJobResourceInAnotherProcessingJob | There is another processing failover test job. | The current user already has a failover test job in progress. Please complete it and try again. |
| 400 | IllegalParam.ResourceId | The input parameter resource ID is invalid. | The input parameter resource ID is invalid. |
| 400 | IncorrectStatus.ResourceId | The specified resource status is invalid. | The resource status corresponding to the entered resource ID is invalid. |
| 400 | IncorrectBusinessStatus.ResourceId | The specified resource business status is invalid. | The entered resource is in arrears. |
| 400 | VpconnNotAssociatedVbr | The specified vpconn is not associated with vbr. | The entered virtual physical connection is not associated with a virtual border router. |
| 400 | VpconnWithVlan0NotSupportShutdown | The specified virtualPhysicalConnection with vlan 0 does not support shutdown. | The shared physical connection of VLAN 0 does not support failover test. |
| 400 | PconnContainsMoreThanOneVpconn | The specified physicalConnection contains more than one virtualPhysicalConnection. | A physical line that contains more than one shared physical line does not support failover test. |
| 400 | PconnContailsMoreThanOneAcrossCountVbr | The specified physicalConnection contains more than one virtualBorderRouter which is across count. | Physical connections that contain more than one cross-account VBR do not support failover test. |
| 400 | EcFailoverTestJobConflict | The current failover test job task is in operation, please try again later. | The current failover test job task is in operation, please try again later. |
| 400 | AnotherJobTesting | There is another job which is testing. | The same user can only perform one fault drill task in the same region at the same time. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-19 | The Error code has changed | View Change Details |