Verify Failover Test Status via DescribeFailoverTestJob - Express Connect - Alibaba Cloud - Express Connect

Queries the details of an Express Connect failover test job by calling the DescribeFailoverTestJob operation.

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

get

*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. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
ClientToken	string	No	The ID of the failover test job.	123e4567-e89b-12d3-a456-426655440000
JobId	string	Yes	The ID of the failover test.	ftj-bp1yh6mvi13aq****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C44F62BE-9CE7-4277-B117-69243F3988BF
FailoverTestJobModel	object	The failover test job.
JobId	string	The ID of the failover test job.	ftj-bp1yh6mvi13aq3g8w****
Name	string	The name of the failover test job. The name is 0 to 128 characters in length and cannot start with `http://` or `https://`.	test
Description	string	The description of the failover test job. The description is 0 to 256 characters in length and cannot start with `http://` or `https://`.	test
ResourceType	string	The resource type for the failover test. Valid values: PHYSICALCONNECTION: Express Connect circuit.	PHYSICALCONNECTION
ResourceId	array	The list of failover test resource IDs.
	string	The ID of the failover test resource.	pc-hp34pxu31qo36a72u****
JobType	string	The failover test type. Valid values: StartNow: starts immediately. The failover test starts immediately after the job is created. StartLater: starts later. Only the job is created without starting the test.	StartNow
JobDuration	string	The failover test duration. Unit: minutes. Valid values: 1 to 4320.	60
StartTime	string	The start time of the failover test job. The time is displayed in UTC in the YYYY-MM-DDThh:mm:ssZ format.	2023-11-21T14:00:00Z
StopTime	string	The end time of the failover test job. The time is displayed in UTC in the YYYY-MM-DDThh:mm:ssZ format.	2023-11-21T15:00:00Z
Status	string	The status of the failover test job. Valid values: Init: pending. Starting: starting. Testing: in progress. Stopping: stopping. Stopped: completed.	Init

Examples

Success response

JSON format

{
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF",
  "FailoverTestJobModel": {
    "JobId": "ftj-bp1yh6mvi13aq3g8w****",
    "Name": "test",
    "Description": "test",
    "ResourceType": "PHYSICALCONNECTION",
    "ResourceId": [
      "pc-hp34pxu31qo36a72u****"
    ],
    "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.