DescribeFailoverTestJob - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries failover tests.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeFailoverTestJob	get	All Resources ``	none	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

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C44F62BE-9CE7-4277-B117-69243F3988BF
FailoverTestJobModel	object	The failover test.
JobId	string	The ID of the failover test.	ftj-xxxxxxxxx
Name	string	The name of the failover test. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	test
Description	string	The description of the failover test. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	test
ResourceType	string	The type of failover test resource. Only PHYSICALCONNECTION is returned.	PHYSICALCONNECTION
ResourceId	array	The IDs of failover test resources.
ResourceId	string	The ID of the resource.	pc-hp34pxu31qo36a72u7mgo
JobType	string	Indicates whether the failover test is performed immediately. Valid values: StartNow StartLater	StartNow
JobDuration	string	The duration of the failover test. Unit: minutes. Valid values: 1 to 4320.	60
StartTime	string	The start time of the failover test. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2023-11-21T14:00:00Z
StopTime	string	The end time of the failover test. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2023-11-21T15:00:00Z
Status	string	The status of the failover test. Valid values: Init Starting Testing Stopping Stopped	Init

Examples

Sample success responses

JSONformat

{
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF",
  "FailoverTestJobModel": {
    "JobId": "ftj-xxxxxxxxx\n",
    "Name": "test",
    "Description": "test",
    "ResourceType": "PHYSICALCONNECTION",
    "ResourceId": [
      "pc-hp34pxu31qo36a72u7mgo"
    ],
    "JobType": "StartNow",
    "JobDuration": "60",
    "StartTime": "2023-11-21T14:00:00Z\n",
    "StopTime": "2023-11-21T15:00:00Z\n",
    "Status": "Init"
  }
}

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.

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. The response structure of the API has changed	View Change Details