文档首页/ 云专线 DC/ API参考(吉隆坡区域)/ API/ 虚拟接口/ 查询虚拟接口倒换测试记录列表
更新时间:2024-07-25 GMT+08:00

查询虚拟接口倒换测试记录列表

功能介绍

查询倒换测试记录列表,只展示operate_status为COMPELTE的记录。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:1~2000。

最小值:1

最大值:2000

缺省值:2000

marker

String

上一页最后一条资源记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。

最小长度:0

最大长度:36

fields

Array

显示字段列表

数组长度:1 - 5

sort_dir

Array

返回结果按照升序(asc)或降序(desc)排列,默认为asc

sort_key

String

排序字段。

缺省值:id

最小长度:0

最大长度:36

resource_id

Array

通过RESOURCE-ID过滤倒换测试记录信息

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:10240

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

操作请求ID

switchover_test_records

Array of SwitchoverTestRecord objects

倒换测试记录信息列表

page_info

PageInfo object

分页查询页的信息

表5 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
表6 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的marker,值为资源的uuid

最小长度:0

最大长度:36

current_count

Integer

当前列表中资源数量

最小值:0

最大值:2000

next_marker

String

下一页的marker,值为资源的uuid,为空时表示最后一页

最小长度:0

最大长度:36

请求示例

查询倒换测试记录列表

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

响应示例

状态码: 200

OK

{
  "request_id" : "bb154519fb167f99cdb01b7b9995ad14",
  "switchover_test_records" : [ {
    "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-10T10:41:23.000Z",
    "end_time" : "2023-10-10T10:41:23.000Z",
    "operate_status" : "COMPLETE"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码