跳转到主要内容
ZStack
资源中心/网络服务/网络服务相关接口/Netflow相关接口

创建流量监控资源

创建流量监控资源

POST/zstack/v1/flowmeters

操作 ID

CreateFlowMeter

起始版本

3.6.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • params
    Object必填

    请求体参数结构

    • version
      String

      流量监控协议的版本号

    • type
      String必填

      流量监控使用的协议

    • sample
      Integer

      流量监控的采样率

    • generateInterval
      Integer

      流量监控向搜集器发送的时间间隔

    • name
      String

      资源名称

    • description
      String

      资源的详细描述

    • server
      String

      搜集器的ip地址

    • port
      Long

      搜集器服务的UDP端口

    • resourceUuid
      String

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuids
      List

      标签UUID列表

  • systemTags
    List

    系统标签

  • userTags
    List

    用户标签

响应状态

200 OK
200 OK

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

  • error
    ErrorCode必填

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

    • code
      String必填

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

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

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

  • inventory
    FlowMeterInventory必填

    详情参考inventory

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • name
      String必填

      资源名称

    • description
      String

      资源的详细描述

    • sample
      Long必填

      流的采样率

    • expireInterval
      Long必填

      流发送间隔

    • version
      String必填

      流量监控协议的版本

    • type
      String必填

      流量监控协议

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

    • collectors
      List必填

      详情参考collectors

      • uuid
        String必填

        资源的UUID，唯一标示该资源

      • name
        String必填

        资源名称

      • description
        String

        资源的详细描述

      • flowMeterUuid
        String必填

        暂无描述。

      • server
        String必填

        搜集器IP

      • port
        Long必填

        搜集器的UDP端口

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间

    • networkRefs
      List必填

      详情参考networkRefs

      • uuid
        String必填

        资源的UUID，唯一标示该资源

      • vRouterUuid
        String必填

        暂无描述。

      • flowMeterUuid
        String必填

        暂无描述。

      • l3NetworkUuid
        String必填

        三层网络UUID

      • createDate
        Timestamp必填

        创建时间

      • lastOpDate
        Timestamp必填

        最后一次修改时间