Modify Active Failover Tests via UpdateFailoverTestJob API - Express Connect - Alibaba Cloud - Express Connect

Updates a failover test job for Express Connect.

Operation description

Only failover test jobs in the Pending state can be updated.

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

update

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

*VirtualBorderRouter

acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the failover test job. You can call DescribeRegions 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 client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value of each API request is different.	123e4567-e89b-12d3-a456-426655440000
ClientToken	string	No	The name of the failover test job. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	123e4567-e89b-12d3-a456-426655440000
Name	string	No	The description of the failover test job. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	test
Description	string	No	The list of failover test resource IDs. You can add up to 16 resources.	test
ResourceId	array	No	The duration of the failover test job. Unit: minutes. Valid values: 1 to 4320.
	string	No	The ID of the resource.	pc-uf66k4e8pq3r00jfq****
JobDuration	integer	No	The failover test job ID.	60
JobId	string	Yes	Specifies whether to perform a dry run. Valid values: true: performs a dry run without updating the failover test node. The system checks the AccessKey pair, the authorization of the Resource Access Management (RAM) user, and the required parameters. If the check fails, the corresponding error is returned. If the check succeeds, the DryRunOperation error code is returned. false (default): sends a Normal request. If the check succeeds, a 2xx HTTP status code is returned and the failover test job is updated.	ftj-bp1yh6mvi13aq3g8w****
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including invalid AccessKey pairs, unauthorized RAM users, and missing parameter values. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C44F62BE-9CE7-4277-B117-69243F3988BF

Examples

Success response

JSON format

{
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.Name	The param of Name [%s] is illegal.	The error message returned because the Name parameter is set to an invalid value. Specify a valid value and try again.
400	IllegalParam.Description	The param of Description [%s] is illegal.	The error message returned because the Description parameter is set to an invalid value. Specify a valid values and try again.
400	EcFailoverTestJobExceedMaxResourceNum	The input resource number is exceeded the quota of 16.	The failover test job can add up to 16 resources.
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	IllegalParam.JobDuration	The specified parameter JobDuration is illegal.	The task duration entered is illegal.
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 fault drill task to be drilled can be modified or started.
400	MultiplePconnSingleVbrNotSupportShutdown	Vbr for single vbr and multiple pconn scenarios does not support failover test job.	The vbr of a single vbr and multiple pconn scenarios does not support failover test job.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.