跳转到主要内容
设置/时间管理相关接口

检查多个主机之间的网络连通性

检查多个主机之间的网络连通性

GET/zstack/v1/zops/check/network

操作 ID

CheckNetworkReachable

起始版本

4.7.21

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • sourceHostnames
    List

    源指定ip地址或域名集合

  • targetHostnames
    List必填

    目标ip地址或域名集合

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

      根错误,引发当前错误的源错误,若无原错误,该字段为null

  • results
    List必填

    详情参考results

    • sourceHostname
      String必填

      源地址

    • targetHostname
      String必填

      目标地址

    • status
      HostConnectedStatus必填

      详情参考status

      • Connected
        HostConnectedStatus必填

        网络可达

      • Disconnected
        HostConnectedStatus必填

        网络不可达

      • Unknown
        HostConnectedStatus必填

        网络连接状态未知