Service Health Probe Manager APIs

Version 7.1.0

v7.0.0 - 2024-08-24

Changed

POST /probeStatusReport

Request:

Changed content type : application/json

• Changed property serviceId (string)

  Service ID.

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body.

• Changed content type : application/json

  • Changed property serviceId (string)

    Service id

  • Changed property enableReactivate (boolean)

    True if the probe re-activate button needs to be enabled in the UI

  • Changed property error (string)

    Error message

  • Changed property endpointStatus (array)

    Detailed status of all endpoints

    Changed items (object): > Probe endpoint status report.

    • Changed property id (string)

      This is the key ID of the endpoint in the service configuration payload.

    • Changed property vpnNeId (string)

      VPN Node ID

    • Changed property agentVLAN (integer)

      Agent VLAN

    • Changed property agentIPAddr (string)

      Agent IP Addr

    • Changed property interfaceName (string)

      Interface Name

    • Changed property error (string)

      Error message

  • Changed property sessionStatus (array)

    Detailed status of all sessions

    Changed items (object): > Probe session status report

    • Changed property id (string)

      Session ID. This is the UUID that the Probe Manager used to create the session in the Accedian server.

    • Changed property sender (string)

      Sender endpoint of the session. This is the key ID of the endpoint in the service configuration payload.

    • Changed property reflector (string)

      Reflector endpoint of the session. This is the key ID of the endpoint in the service configuration payload.

    • Changed property error (string)

      Error message

Changed response : **default **

An empty response.

• Changed content type : application/json

  • Changed property error (string)

    Error of Run-time error.

  • Changed property code (integer)

    Code of Run-time error.

  • Changed property message (string)

    Message of Run-time error.

  • Changed property details (array)

    Details of Run-time error.

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny.

    • Changed property value (string)

      Value of ProtobufAny.

POST /reactivateProbe

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body.

• Changed content type : application/json

  • Changed property error (string)

    Error message

  • Changed property status (string)

    Status of Probe Activation Response

Changed response : **default **

An unexpected error response.

• Changed content type : application/json

  • Changed property error (string)

    Error of Run-time error.

  • Changed property code (integer)

    Code of Run-time error.

  • Changed property message (string)

    Message of Run-time error.

  • Changed property details (array)

    Details of Run-time error.

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny.

    • Changed property value (string)

      Value of ProtobufAny.