Skip to main content
ZStack
Resource Center/Network Service/Network Service Operations/NetFlow APIs

CreateFlowMeter

CreateFlowMeter

POST/zstack/v1/flowmeters

Operation ID

CreateFlowMeter

Since

3.6.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • version
      String

      Optional. The flow monitoring protocol version.

    • type
      StringRequired

      The flow monitoring protocol.

    • sample
      Integer

      Optional. The flow monitoring sampling rate.

    • generateInterval
      Integer

      Optional. The interval at which flow data is sent to the collector.

    • name
      String

      Optional. The resource name.

    • description
      String

      Optional. The detailed description of the resource.

    • server
      String

      Optional. The collector IP address.

    • port
      Long

      Optional. The collector service UDP port.

    • resourceUuid
      String

      Optional. The resource UUID.

    • tagUuids
      List

      Optional. The list of tag UUIDs.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    Error code, null if operation succeeds, non-null if operation fails, see error

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    FlowMeterInventoryRequired

    See inventory

    • uuid
      StringRequired

      The resource UUID.

    • name
      StringRequired

      The resource name.

    • description
      String

      Optional. The detailed description of the resource.

    • sample
      LongRequired

      The sample rate of the flow meter.

    • expireInterval
      LongRequired

      The expiration interval of the flow.

    • version
      StringRequired

      The version of the flow meter protocol.

    • type
      StringRequired

      The type of the flow meter protocol.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • collectors
      ListRequired

      See collectors

      • uuid
        StringRequired

        The resource UUID.

      • name
        StringRequired

        The resource name.

      • description
        String

        Optional. The detailed description of the resource.

      • flowMeterUuid
        StringRequired

        The flow meter UUID.

      • server
        StringRequired

        The IP address of the flow collector.

      • port
        LongRequired

        The UDP port of the flow collector.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.

    • networkRefs
      ListRequired

      See networkRefs

      • uuid
        StringRequired

        The resource UUID.

      • vRouterUuid
        StringRequired

        The vRouter UUID.

      • flowMeterUuid
        StringRequired

        The flow meter UUID.

      • l3NetworkUuid
        StringRequired

        The L3 network UUID.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.