All Products
Search

This Product

    Virtual Private Cloud:CreateFailoverTestJob

    Document Center

    Virtual Private Cloud:CreateFailoverTestJob

    Last Updated:Dec 20, 2024

    Creates a failover test.

    Operation description

    You cannot create a failover test in the following scenarios:

    • You have created a failover test in the region and its type is StartNow.
    • The Express Connect circuit or hosted connection has pending orders or overdue payments.
    • A failover test is already performed on the Express Connect circuit or hosted connection.
    • More than one hosted connection is created over the Express Connect circuit.
    • More than one cross-account VBR is created on the Express Connect circuit.
    • No VBR is associated with the hosted connection.
    • The VLAN ID of the hosted connection is set to 0.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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 Resources is 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:CreateFailoverTestJobcreate
    *VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}
    *PhysicalConnection
    acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the failover test.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ClientTokenstringYes

    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
    NamestringNo

    The name of the failover test.

    The name must be 0 to 128 characters in length and cannot start with http:// or https://.

    		test
    DescriptionstringNo

    The description of the failover test.

    The description must be 0 to 256 characters in length and cannot start with http:// or https://.

    		test
    ResourceTypestringYes

    The resource type of the failover test. Set the value to PHYSICALCONNECTION.

    		PHYSICALCONNECTION
    ResourceIdarrayYes

    The IDs of failover test resources. You can add at most 16 resources.

    stringYes

    The ID of the resource.

    		pc-uf66k4e8pq3r00jfqo0b5
    JobTypestringYes

    The type of the failover test. Valid values:

    • StartNow
    • StartLater
    		StartNow
    JobDurationintegerYes

    The duration of the failover test. Unit: minutes. Valid values: 1 to 4320.

    		60
    DryRunbooleanNo

    If you set the value to true, the system performs only a dry run without actually performing the actual request. If you set the value to false, the system 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 parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		C44F62BE-9CE7-4277-B117-69243F3988BF
    JobIdstring

    The ID of the failover test.

    		ftj-xxxxxxxxx

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF\n",
  "JobId": "ftj-xxxxxxxxx"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.NameThe 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.
    400IllegalParam.DescriptionThe 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.
    400IllegalParam.ResourceTypeInvalid Resource Type value.The ResourceType parameter is not supported or set to an invalid value.
    400EcFailoverTestJobExceedMaxResourceNumThe input resource number is exceeded the quota of 16.The failover test job can add up to 16 resources.
    400EcFailoverTestJobResourceInAnotherProcessingJobThere is another processing failover test job.The current user already has a failover test job in progress. Please complete it and try again.
    400IllegalParam.ResourceIdThe input parameter resource ID is invalid.The input parameter resource ID is invalid.
    400IncorrectStatus.ResourceIdThe specified resource status is invalid.The resource status corresponding to the entered resource ID is invalid.
    400IncorrectBusinessStatus.ResourceIdThe specified resource business status is invalid.The entered resource is in arrears.
    400VpconnNotAssociatedVbrThe specified vpconn is not associated with vbr.The entered virtual physical connection is not associated with a virtual border router.
    400VpconnWithVlan0NotSupportShutdownThe specified virtualPhysicalConnection with vlan 0 does not support shutdown.The shared physical connection of VLAN 0 does not support failover test.
    400PconnContainsMoreThanOneVpconnThe specified physicalConnection contains more than one virtualPhysicalConnection.A physical line that contains more than one shared physical line does not support failover test.
    400PconnContailsMoreThanOneAcrossCountVbrThe 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.
    400IllegalParam.JobTypeThe specified parameter JobType is illegal.The task type entered is illegal.
    400IllegalParam.JobDurationThe specified parameter JobDuration is illegal.The task duration entered is illegal.
    400AnotherJobTestingThere is another job which is testing.The same user can only perform one fault drill task in the same region at the same time.
    400MultiplePconnSingleVbrNotSupportShutdownVbr 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.
    400EcFailoverTestJobConflictThe 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.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-07-19The Error code has changed. The request parameters of the API has changedView Change Details