{"type":"api","title":"Use probeStatusReport to get probe status","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/5353f359-00fd-349d-ab9d-94968f26400d","info":{"title":"Service Health Probe Manager APIs","description":"Probe Manager related APIs for the Crosswork Service Health application.","termsOfService":"terms-of-service","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/aa_probemgr_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/probemgr/v1/"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"tags":["AaProbeManager"],"summary":"Use probeStatusReport to get probe status.","operationId":"AaProbeManager_GetProbeStatusReport","requestBody":{"description":"The Probe Status request parameter.","content":{"application/json":{"schema":{"type":"object","properties":{"serviceId":{"description":"Service ID.","type":"string"}},"description":"Use ProbeStatusRequest to fetch a detailed probe status for a service.","$$ref":"#/components/schemas/ProbeStatusRequest"},"example":{"serviceId":"ietf-l3vpn-ntw:l3vpn-ntw/vpn-services/vpn-service=L3VPN_5EP_10"}}},"required":true},"responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"serviceId":{"type":"string","description":"Service id"},"enableReactivate":{"description":"True if the probe re-activate button needs to be enabled in the UI","type":"boolean"},"status":{"type":"string","description":"Status of probe/endpoint/session","default":"PROBE_STATUS_UNKNOWN","enum":["PROBE_STATUS_UNKNOWN","PROBE_STATUS_PENDING","PROBE_STATUS_SUCCESS","PROBE_STATUS_ERROR"],"$$ref":"#/components/schemas/ProbeStatus"},"endpointStatus":{"description":"Detailed status of all endpoints","type":"array","items":{"type":"object","properties":{"id":{"description":"This is the key ID of the endpoint in the service configuration payload.","type":"string"},"vpnNeId":{"type":"string","description":"VPN Node ID"},"agentVLAN":{"type":"integer","description":"Agent VLAN","format":"int64"},"agentIPAddr":{"type":"string","description":"Agent IP Addr"},"interfaceName":{"type":"string","description":"Interface Name"},"status":{"type":"string","description":"Status of probe/endpoint/session","default":"PROBE_STATUS_UNKNOWN","enum":["PROBE_STATUS_UNKNOWN","PROBE_STATUS_PENDING","PROBE_STATUS_SUCCESS","PROBE_STATUS_ERROR"],"$$ref":"#/components/schemas/ProbeStatus"},"error":{"description":"Error message","type":"string"}},"description":"Probe endpoint status report.","$$ref":"#/components/schemas/ProbeEndpointStatus"}},"sessionStatus":{"description":"Detailed status of all sessions","type":"array","items":{"type":"object","properties":{"id":{"description":"Session ID. This is the UUID that the Probe Manager used to create the session in the Accedian server.","type":"string"},"sender":{"description":"Sender endpoint of the session. This is the key ID of the endpoint in the service configuration payload.","type":"string"},"reflector":{"description":"Reflector endpoint of the session. This is the key ID of the endpoint in the service configuration payload.","type":"string"},"status":{"type":"string","description":"Status of probe/endpoint/session","default":"PROBE_STATUS_UNKNOWN","enum":["PROBE_STATUS_UNKNOWN","PROBE_STATUS_PENDING","PROBE_STATUS_SUCCESS","PROBE_STATUS_ERROR"],"$$ref":"#/components/schemas/ProbeStatus"},"error":{"description":"Error message","type":"string"}},"description":"Probe session status report","$$ref":"#/components/schemas/ProbeSessionStatus"}},"error":{"description":"Error message","type":"string"}},"description":"Probe status response","$$ref":"#/components/schemas/ProbeStatusResponse"},"example":{"data":[{"serviceId":"ietf-l3vpn-ntw:l3vpn-ntw/vpn-services/vpn-service=L3NM-PROBES-45-2-3-hub-spoke","enableReactivate":true,"status":3,"endpointStatus":[{"id":"def","vpnNeId":"Node3","agentVLAN":22,"agentIPAddr":"30.1.3.252","interfaceName":"GigabitEthernet0/0/0/1","status":2}],"sessionStatus":[{"id":"0f701fff-91ec-557e-9cf1-737c67125d3c","sender":"def","reflector":"abc","status":3}]}]}}}},"default":{"description":"An empty response.","content":{"application/json":{"schema":{"type":"object","description":"Run-time error.","properties":{"error":{"type":"string","description":"Error of Run-time error."},"code":{"type":"integer","description":"Code of Run-time error.","format":"int32"},"message":{"type":"string","description":"Message of Run-time error."},"details":{"type":"array","description":"Details of Run-time error.","items":{"type":"object","description":"ProtobufAny","properties":{"type_url":{"type":"string","description":"Type-url of ProtobufAny."},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Value of ProtobufAny.","format":"byte"}},"$$ref":"#/components/schemas/protobufAny"}}},"$$ref":"#/components/schemas/runtimeError"},"example":{"data":[{"status":"SUCCESS"}]}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"AaProbeManager_GetProbeStatusReport","security":[{"bearerAuth":[]}],"method":"post","path":"/probeStatusReport"}}