调用 DescribeFailoverJobs 接口，查询故障演练任务。

调试

API Explorer

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

去调试

请求参数

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

Action String 必选示例值：DescribeFailoverJobs

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

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

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

JobIds.N String 可选示例值：foj-1234***

健康检查探针的ID。

参数 - N：表示故障演练任务ID的序号，单次调用数量上限100个。

多个故障演练任务ID之间用&分隔。

JobName String 可选示例值：FailoverJob-01

故障演练任务的名称。

JobType String 可选示例值：dcc

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

dcc：物理专线。

bgp：BGP邻居。

PageNumber Integer 可选示例值：1

列表的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

返回参数

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

TotalCount Integer 示例值：1

满足指定条件的故障演练任务总数。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：20

当前分页的行数。

FailoverJobs Object[] 示例值：-

故障演练任务的详细信息。

AccountId String 示例值：20000***

用户的账号ID。

CreatedAt String 示例值：2025-07-03 10:48:21

故障演练任务创建的时间。

Description String 示例值：This is a FailoverJob

故障演练任务的描述。

JobDuration Integer 示例值：10

故障演练时长，单位：分钟。

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

故障演练任务的ID。

JobName String 示例值：FailoverJob-01

故障演练任务的名称。

JobStartAt String 示例值：2025-07-03 10:48:21

故障演练任务开始的时间。如果任务尚未开始，返回-。

JobStatus String 示例值：starting

故障演练任务的状态。

creating：任务创建中。

updating：任务更新中。

prepare：任务未启动。

starting：任务启动中。

running：任务运行中。

stopping：任务结束中。

completed：任务完成。

deleting：任务删除中。

JobStopAt String 示例值：2025-07-03 10:58:21

故障演练任务完成的时间。如果任务尚未完成，返回-。

JobTotalTime Integer 示例值：600

故障演练任务实际运行总时长，单位：秒。如果任务尚未完成，返回0。

JobType String 示例值：dcc

演练任务的类型。

dcc：物理专线。

bgp：BGP邻居。

ObjectCount Integer 示例值：2

故障演练对象资源总数。

Objects Object[] 示例值：-

故障演练对象资源的详细信息。

ObjectId String 示例值：dcc-d012mga***

故障演练对象资源的ID。

DirectConnectConnectionName String 示例值：dcc-01

物理专线的名称。

VirtualInterfaceId String 示例值：dcv-7qth0ll6jmc****

虚拟接口的ID。

VirtualInterfaceName String 示例值：dcv-01

虚拟接口的名称。

PeerIp String 示例值：192.XX.XX.1/24

对端网关互联IP地址。

LocalIp String 示例值：192.XX.XX.2/24

本端网关互联IP地址。

ConnectionType String 示例值：SharedConnection

物理专线的类型。

SharedConnection：共享专线。

DedicatedConnection：独享专线。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
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	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.FailoverJobId	You've reached the limit on the number of failover job IDs that you can describe.	已达到可查询的故障演练任务ID数量上限。
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.	无权限对指定的账号进行故障演练任务操作。

专线连接