All Products
Search
Document Center

Virtual Private Cloud:DeleteFailoverTestJob

Last Updated:Aug 29, 2024

Deletes a failover test.

Operation description

You can delete only failover tests that are in the Pending or Complete state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DeleteFailoverTestJobdelete
  • All Resources
    *
    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.

ch-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
JobIdstringYes

The ID of the failover test.

ftj-xxxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

C44F62BE-9CE7-4277-B117-69243F3988BF

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.JobIdThe specified parameter JobId is illegal.The entered failover test job ID is invalid.
400IncorrectStatus.OnlyForInitOrStoppedOnly failover test job in the status of init or stopped can be deleted.Only failover test job in the status of init or stopped can be deleted.
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 changedView Change Details