文档首页/ 云专线 DC/ API参考（吉隆坡区域）/ API/ 虚拟接口/ 执行虚拟接口倒换测试
更新时间：2024-07-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

执行虚拟接口倒换测试

功能介绍

客户双专线接入，需要支持双线自动倒换，方便进行功能测试。 虚拟接口进行倒换测试会导致接口关闭，业务流量中断。 对于虚拟接口，支持“关闭接口”和“开放接口”两种操作。 1、关闭接口：下发shutdown命令，关闭接口； 2、开放接口：下发undo_shutdown命令，使能接口。 倒换测试选择shutdown时，虚拟接口的状态为ADMIN_SHUTDOWN，此状态不允许虚拟接口的其他操作。 倒换测试选择undo_shutdown时，虚拟接口的状态为ACTIVE。

URI

POST /v3/{project_id}/dcaas/switchover-test

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：0

最大长度：10240
表3 请求Body参数

参数

是否必选

参数类型

描述

switchover_test_record

否

CreateSwitchoverTest object

创建倒换测试记录对象参数
表4 CreateSwitchoverTest

参数

是否必选

参数类型

描述

resource_id

是

String

倒换测试的资源对象ID

resource_type

否

String

倒换测试的资源对象类型

缺省值：virtual_interface

最小长度：0

最大长度：128

枚举值：

  • virtual_interface

operation

是

String

shutdown, undo_shutdown表示倒换测试操作类型

最小长度：0

最大长度：128

枚举值：

  • shutdown
  • undo_shutdown

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

request_id

String

操作请求ID

switchover_test_record

SwitchoverTestRecord object

倒换测试记录信息
表6 SwitchoverTestRecord

参数

参数类型

描述

id

String

倒换测试记录的唯一标识

tenant_id

String

租户ID

最小长度：32

最大长度：32

resource_id

String

倒换测试的资源对象ID

resource_type

String

倒换测试的资源对象类型

缺省值：virtual_interface

最小长度：0

最大长度：128

枚举值：

  • virtual_interface

operation

String

shutdown, undo_shutdown表示倒换测试操作类型

最小长度：0

最大长度：128

枚举值：

  • shutdown
  • undo_shutdown

start_time

String

倒换测试操作的开始时间

end_time

String

倒换测试操作的结束时间

operate_status

String

倒换测试状态记录 STARTING: 初始状态 INPROGRESS: 配置下发中 COMPLETE: 配置下发完成 ERROR: 配置下发失败

枚举值：

  • STARTING
  • INPROGRESS
  • COMPLETE
  • ERROR

请求示例

对虚拟接口下发shutdown命令，关闭接口。

POST https://{dc_endpoint}/v3/de58f033eb664102ba85e4a5db473ca5/dcaas/switchover-test

{
  "switchover_test_record" : {
    "resource_type" : "virtual_interface",
    "resource_id" : "d0b3329c-0063-470c-b1dc-657656b2e540",
    "operation" : "shutdown"
  }
}

响应示例

状态码： 201

Created

{
  "switchover_test_record" : {
    "id" : "862d61f1-d9ea-4093-ba0e-2b8d415e3ab3",
    "tenant_id" : "de58f033eb664102ba85e4a5db473ca5",
    "resource_type" : "virtual_interface",
    "resource_id" : "d0b3329c-0063-470c-b1dc-657656b2e540",
    "operation" : "shutdown",
    "start_time" : "2023-10-09T18:41:23.000Z",
    "end_time" : "2023-10-09T18:41:23.000Z",
    "operate_status" : "STARTING"
  },
  "request_id" : "f91634a12b116b6f946d7871f5b4de18"
}

状态码

状态码

描述

201

Created

错误码

请参见错误码。

父主题： 虚拟接口