Direct Connect
Direct Connect
Document
- Documentation
Direct ConnectAPI ReferenceFailure drillCreateFailoverJob - Creating a failure drill task
Copy page
Download PDFFailure drill
CreateFailoverJob - Creating a failure drill task
Copy pageDownload PDFCreateFailoverJob - Creating a failure drill task
Call the CreateFailoverJob API to create a failure drill task.
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 required Example: CreateFailoverJob
The interface name. The current API name is CreateFailoverJob.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
JobName String optional Example: FailoverJob-01
The name of the failure drill task.
- Must be 1 to 128 characters.
- Must start with a letter, Chinese character, or number. May include periods (.), underscores (_), and hyphens (-). Cannot start with http:// or https://.
- If you do not provide this parameter or leave it empty, it defaults to the ID of the failure drill task.
Description String optional Example: This is a FailoverJob
The description of the failure drill task.
- Must start with a Chinese character, letter, or number. May include Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), commas (,), Chinese commas (，), and Chinese periods (。).
- Must be 0 to 255 characters.
- If you do not provide this parameter or leave it unset, it defaults to an empty string.
JobType String required Example: dcc
The type of the target to be drilled for the failure drill task. Values:
- dcc: Direct Connect (DC) Connection.
- bgp: BGP Peer.
JobDuration Integer required Example: 10
The duration of the failure drill. Value range: 1-4320. Unit: minutes.
JobAct String optional Example: start
Specify whether to start the failure drill immediately. Values:
- start: Yes.
- null (default): No.
Objects.N.ObjectId String optional Example: dcc-d012mga***
The resource ID of the target to be drilled. Values:
- The ID of the DC Connection. This parameter must be set to the DC Connection ID when JobType is dcc. You can call the DescribeDirectConnectConnections API to query the DC Connection ID.
- The ID of the BGP Peer. This parameter must be set to the BGP Peer ID when JobType is bgp. You can call the DescribeBgpPeers API to query the BGP Peer ID.
Objects.N.DirectConnectConnectionName String Optional Example: dcc-01
The name of the DC Connection. This parameter is configurable only if JobType is set to dcc.
You can call the DescribeDirectConnectConnectionAttributes API to query the name of the DC Connection.
Objects.N.ConnectionType String optional Example: DedicatedConnection
The type of the DC Connection. This parameter is configured only if JobType is set to dcc. Values:
- SharedConnection: Shared Line.
- DedicatedConnection: Dedicated Line.
Objects.N.VirtualInterfaceId String optional Example: dcv-7qth0ll6jmc****
The ID of the DC Virtual Interface associated with the BGP Peer. This parameter is configurable only if JobType is set to bgp.
Objects.N.VirtualInterfaceName String optional Example: DCv-01
The name of the DC Virtual Interface associated with the BGP peer. This parameter is configurable only if JobType is set to bgp.
You can call DescribeDirectConnectVirtualInterfaceAttributes to query the name of the DC Virtual Interface.
Objects.N.PeerIP String optional Example: 192.XXX.XXX.1/24
Your gateway peer IP of the DC Virtual Interface. This parameter is configurable only if JobType is set to bgp.
You can call DescribeDirectConnectVirtualInterfaceAttributes to query the IP address of the DC Virtual Interface.
Objects.N.LocalIP String optional Example: 192.XXX.XXX.1/24
Cloud gateway peer IP of the DC Virtual Interface. This parameter is configurable only if JobType is set to bgp.
You can call DescribeDirectConnectVirtualInterfaceAttributes to query the IP address of the DC Virtual Interface.
Response parameters
The following only details response parameters specific to this API. For more information, see Response structure.
JobId String Example: foj-1234***
The ID of the failure drill task.
Request examples
GET /?Action=CreateFailoverJob&Version=2020-04-01&JobType=dcc&JobDuration=10&Objects.1.ObjectId=dcc-d012mga*** 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": "2021062415303301022514515207C4****",
"Action": "CreateFailoverJob",
"Version": "2020-04-01",
"Service": "directconnect",
"Region": "ap-southeast-1"
},
"Result": {
"RequestId": "2021062415303301022514515207C4****",
"DirectConnectHealthCheckId": "foj-1234***"
}
}
Error codes
The table below describes the error codes for this API that are associated with business logic. For details, see Common error codes.
Last updated: 2026.03.04 14:05:37
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
