Direct Connect
Direct Connect
Document
- Documentation
Direct ConnectAPI ReferenceFailure drillDescribeFailoverJobs - Querying the list of failure drill tasks
Copy page
Download PDFFailure drill
DescribeFailoverJobs - Querying the list of failure drill tasks
Copy pageDownload PDFDescribeFailoverJobs - Querying the list of failure drill tasks
Call the DescribeFailoverJobs API to query failure drill tasks that meet specified conditions.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String requiredExample: DescribeFailoverJobs
The interface name. The current API name is DescribeFailoverJobs.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
JobIds.N String optional Example: foj-1234***
The ID of the health check probe.
- N represents the sequence number of a failure drill task ID. You can call up to 100 IDs per request.
- Separate multiple failure drill task IDs with ampersands (&).
JobName String optional Example: FailoverJob-01
The name of the failure drill task.
JobType String optional Example: dcc
The type of the target to be drilled for the failure drill task. Values:
- dcc: Direct Connect (DC) Connection.
- bgp: BGP Peer.
PageNumber Integer optional Example: 1
The page number of the list.
- Set a non-negative integer to this parameter.
- If left blank or set to 0, it defaults to 1.
PageSize Integer optional Example: 20
The number of entries per page in a pagination query. Maximum: 100. Default: 20.
Response parameters
The following only details response parameters specific to this API. For more information, see Response structure.
TotalCount Integer Example: 1
The total number of failure drill tasks meeting the specified conditions.
PageNumber Integer Example: 1
The current page number.
PageSize Integer Example: 20
Number of entries per page in the current pagination.
FailoverJobs Object[] Example: -
The details of the failure drill task.
AccountId String Example: 20000***
The account ID of the user.
CreatedAt String Example: 2025-07-03 10:48:21
The time when the failure drill task is created.
Description String Example: This is a FailoverJob
The description of the failure drill task.
JobDuration Integer Example: 10
The duration of the failure drill. Unit: minutes.
JobId String Example: foj-1234****
The ID of the failure drill task.
JobName String Example: FailoverJob-01
The name of the failure drill task.
JobStartAt String Example: 2025-07-03 10:48:21
The time when the failure drill task starts. Returns - if the task is not started.
JobStatus String Example: starting
The status of the failure drill task.
- creating: The task is being created.
- updating: The task is being updated.
- prepare: The task is not started.
- starting: The task is starting.
- running: The task is running.
- stopping: The task is terminating.
- completed: The task is completed.
- deleting: The task is being deleted.
JobStopAt String Example: 2025-07-03 10:58:21
The time when the failure drill task is completed. Returns - if the task has not completed.
JobTotalTime Integer Example: 600
The actual total running duration of the failure drill task. Unit: seconds. Returns "0" if the task has not completed.
JobType String Example: dcc
The type of the task.
- dcc: Direct Connect (DC) Connection.
- bgp: BGP Peer.
ObjectCount Integer Example: 2
The total number of failure drill target resources.
Objects Object[] Example: -
The details of the failure drill target resource.
ObjectId String Example: dcc-d012mga***
The ID of the failure drill target resource.
DirectConnectConnectionName String Example: dcc-01
Name of the DC Connection.
VirtualInterfaceId String Example: dcv-7qth0ll6jmc****
ID of the DC Virtual interface.
VirtualInterfaceName String Example: dcv-01
Name of the DC Virtual interface.
PeerIp String Example: 192.XX.XX.1/24
Your gateway peer IP address.
LocalIp String Example: 192.XX.XX.2/24
Cloud gateway peer IP address.
ConnectionType String Example: SharedConnection
Type of the DC Connection.
- SharedConnection: Shared Line.
- DedicatedConnection: Dedicated Line.
Request examples
GET /?Action=DescribeFailoverJobs&Version=2020-04-01&JobName=FailoverJob-01 HTTP/1.1
Host: directconnect.cn-beijing.volcengineapi.com
X-Date: 20251121T094038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeFailoverJobs",
"Version": "2020-04-01",
"Service": "directconnect",
"Region": "cn-north-1"
},
"Result": {
"FailoverJobs": [
{
"JobId": "foj-1234****",
"JobName": "FailoverJob-01",
"JobType": "dcc",
"Objects": [
{
"PeerIp": "192.XX.XX.1/24",
"LocalIp": "192.XX.XX.2/24",
"ObjectId": "dcc-d012mga***",
"ConnectionType": "SharedConnection",
"VirtualInterfaceId": "dcv-7qth0ll6jmc****",
"VirtualInterfaceName": "dcv-01",
"DirectConnectConnectionName": "dcc-01"
}
],
"AccountId": "20000***",
"CreatedAt": "2025-07-03 10:48:21",
"JobStatus": "starting",
"JobStopAt": "2025-07-03 10:58:21",
"JobStartAt": "2025-07-03 10:48:21",
"Description": "This is a FailoverJob",
"JobDuration": 10,
"ObjectCount": 2,
"JobTotalTime": 600
}
],
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 1
}
}
Error codes
The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.
Last updated: 2026.03.04 14:05:37
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
