文档中心

专线连接

故障演练任务

CreateFailoverJob - 创建故障演练任务

调用 CreateFailoverJob 接口，创建故障演练任务。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：CreateFailoverJob

接口名称。当前 API 的名称为 CreateFailoverJob。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

JobName String 可选示例值：FailoverJob-01

演练演练任务的名称。

长度限制为1 ~ 128个字符。

需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不能以http:// 或者 https://作为开头。

不传入该参数或该参数不传入数值时，默认为故障演练任务的ID。

Description String 可选示例值：This is a FailoverJob

故障演练任务的描述。

以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。

长度限制为0 ~ 255个字符。

不传入该参数或该参数不传入数值时，默认为空字符串。

JobType String 必选示例值：dcc

故障演练任务演练对象的类型，取值：

dcc：物理专线。

bgp：BGP邻居。

JobDuration Integer 必选示例值：10

故障演练的演练时长，取值范围：1～4320，单位：分钟。

JobAct String 可选示例值：start

是否立即开始故障演练，取值：

start：是。

空值（默认）：否。

Objects.N.ObjectId String 可选示例值：dcc-d012mga***

故障演练对象的资源ID，取值：

物理专线的ID，当JobType取值为dcc时，此参数需要传入物理专线ID。您可以调用DescribeDirectConnectConnections接口查询物理专线的ID。

BGP邻居的ID，当JobType取值为bgp时，此参数需要传入BGP邻居的ID。您可以调用DescribeBgpPeers接口查询BGP邻居的ID。

Objects.N.DirectConnectConnectionName String 可选示例值：dcc-01

物理专线的名称，仅当JobType取值为dcc时，支持配置该参数。

您可以调用DescribeDirectConnectConnectionAttributes接口查询物理专线的名称。

Objects.N.ConnectionType String 可选示例值：DedicatedConnection

物理专线的类型，仅当JobType取值为dcc时，支持配置该参数，取值如下：

SharedConnection：共享专线。

DedicatedConnection：独享专线。

Objects.N.VirtualInterfaceId String 可选示例值：dcv-7qth0ll6jmc****

BGP邻居关联的虚拟接口ID，仅当JobType取值为bgp时，支持配置该参数。

您可以调用DescribeDirectConnectVirtualInterfaces查询虚拟接口的ID。

Objects.N.VirtualInterfaceName String 可选示例值：DCv-01

BGP邻居关联的虚拟接口名称，仅当JobType取值为bgp时，支持配置该参数。

您可以调用DescribeDirectConnectVirtualInterfaceAttributes查询虚拟接口的名称。

Objects.N.PeerIP String 可选示例值：192.XXX.XXX.1/24

虚拟接口对端网关互联IP地址，仅当JobType取值为bgp时，支持配置该参数。

您可以调用DescribeDirectConnectVirtualInterfaceAttributes查询虚拟接口的对端网关互联IP地址。

Objects.N.LocalIP String 可选示例值：192.XXX.XXX.1/24

虚拟接口本端网关互联IP地址，仅当JobType取值为bgp时，支持配置该参数。

您可以调用DescribeDirectConnectVirtualInterfaceAttributes查询虚拟接口的本端网关互联IP地址。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

JobId String 示例值：foj-1234***

故障演练任务的ID。

请求示例

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​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2021062415303301022514515207C4****",​
        "Action": "CreateFailoverJob",​
        "Version": "2020-04-01",​
        "Service": "directconnect",​
        "Region": "ap-southeast-1"​
    },​
    "Result": {​
        "RequestId": "2021062415303301022514515207C4****",​
        "DirectConnectHealthCheckId": "foj-1234***"​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDirectConnectConnection.InvalidBusinessStatus	The specified direct connect connection is not in the correct status for the request. The specified direct connect connection is in freeze.	指定的物理专线所处的状态无法响应该请求。当前物理专线被冻结。
400	InvalidFailoverJob.BGPStatusDown	The BGP session status is down, so it cannot be used in failover job.	BGP会话状态为Down，不能被故障演练任务引用。
400	InvalidFailoverJob.DCCTypeShared	The direct connect connection is shared, so it cannot be used in failover job.	共享专线不能被故障演练任务引用。
400	InvalidFailoverJob.InvalidAct	The failover job action is invalid.	故障演练任务操作不合法。
400	InvalidFailoverJob.InvalidDuration	The failover job duration is invalid.	创建的故障演练任务时长不在指定范围内，应大于1分钟且小于72小时。
400	InvalidFailoverJob.InvalidType	The failover job type is invalid.	创建的故障演练任务类型不支持。
400	InvalidFailoverJob.ObjectInUse	The object has already been used by another job.	对象实例已经存在于其他故障演练任务，不能被重复引用。
400	InvalidFailoverJob.ObjectsInvalid	At least one object instance should be included.	至少应包含一个对象实例。
400	InvalidFailoverJob.OnlyOneBeRunning	Only one failover job is allowed to be started under each account.	每个账号下只允许有一个故障演练任务处于运行状态。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	QuotaExceeded.FailoverJob	You've reached the limit on the number of failover jobs that you can use.	已达到可创建的故障演练任务的数量上限。
400	QuotaExceeded.FailoverJobObject	You've reached the limit on the number of failover job for the object that can be used.	已达到每个故障演练任务可引用的对象实例的数量上限。
403	Forbidden	You are not authorized to perform operations on the specified shared connection.	无权限对指定的共享专线进行操作。
403	InvalidDirectConnectVirtualInterface.CrossAccountForbidden	You are not authorized to allocate the specified virtual interface to other account.	无权限将指定的虚拟接口共享给其他账号。
403	InvalidFailoverJob.Forbidden	You are not authorized to perform failover job operations on the specified account.	无权限对指定的账号进行故障演练任务操作。
404	InvalidBgpPeer.NotFound	The specified BGP peer does not exist.	指定的BGP邻居不存在。
404	InvalidDirectConnectConnection.NotFound	The specified direct connect connection does not exist.	指定的物理专线不存在。

最近更新时间：2026.01.23 17:00:43

这个页面对您有帮助吗？

有用

无用