Get Services Details - Nexus Dashboard API v1, Release 4.2 and above

{"type":"api","title":"Get Services Details","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/65fc3264-ac5a-3c30-875c-02fef61e57b5","info":{"contact":{"name":"Cisco Technical Assistance Center (TAC)","url":"https://developer.cisco.com/docs/nexus-dashboard/latest/#developer-support/"},"description":"Analyze APIs provide visibility across the managed resources","license":{"name":"Cisco","url":"https://www.cisco.com/site/us/en/about/legal/contract-experience/index.html"},"title":"Nexus Dashboard Analyze v1","version":"1.1.209"},"tags":[{"name":"AI Infrastructure and Analytics"},{"name":"Anomalies and Advisories"},{"name":"Compliance Conformance and Update Analysis"},{"name":"Dashboards and Explorer"},{"name":"Endpoints"},{"name":"Energy Management"},{"name":"Flow Analytics"},{"name":"Job and Report Management"},{"name":"Network Connectivity Resources"},{"name":"Resources Summary"},{"name":"Services and Segmentation"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-analyze.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"description":"Nexus Dashboard Analyze APIs","url":"https://{cluster}/api/v1/analyze","variables":{"cluster":{"default":"example.com","description":"The cluster URL/IP address","enum":["example.com","10.1.1.20"]}}}],"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 security scheme","flows":{"implicit":{"authorizationUrl":"https://example.com/login","scopes":{"observer":"Grants read access","fabric-admin":"Grants write access to fabric resources","support-engineer":"Primarily a role for support engineers to operate the managed resources","super-admin":"Grants access to all operations","approver":"Grants access to approve policies","designer":"Grants access to design policies"}}}},"http_signature":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"HTTP Signature security scheme"},"cookieAuth":{"type":"apiKey","description":"Cookie based authentication","in":"cookie","name":"AuthCookie"}}},"spec":{"description":"Get Service endpoints details","operationId":"getServicesDetails","parameters":[{"description":"Name of the fabric","in":"query","name":"fabricName","required":true,"schema":{"type":"string","maxLength":64,"minLength":1},"$$ref":"#/components/parameters/fabricNameRequired"},{"description":"Lucene format filter - Filter the response based on this filter field","in":"query","name":"filter","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/filterRequired"},{"name":"clusterName","description":"Name of the target Nexus Dashboard cluster to execute this API, in a multi-cluster deployment","in":"query","required":false,"schema":{"type":"string","description":"Name of the target Nexus Dashboard cluster to execute this API, in a multi-cluster deployment"},"$$ref":"#/components/parameters/fromClusterQueryParam"},{"description":"Start date","in":"query","name":"startDate","required":false,"schema":{"format":"date-time","type":"string"},"$$ref":"#/components/parameters/startDate"},{"description":"End date","in":"query","name":"endDate","required":false,"schema":{"format":"date-time","type":"string"},"$$ref":"#/components/parameters/endDate"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Detailed information about a service endpoint including location, performance, and conversation attributes.","type":"object","properties":{"fabricName":{"description":"The name of the fabric","type":"string","example":"DC-WEST"},"tenant":{"description":"The tenant name","type":"string","example":"tenant1"},"vrf":{"description":"The VRF (Virtual Routing and Forwarding) name","type":"string","example":"app_vrf-1"},"serviceEndpointIp":{"description":"The IP address of the service instance","type":"string","example":"192.168.10.1"},"serviceEndpointPort":{"description":"The port of the service instance","type":"integer","format":"int32","example":21},"serviceEndpoint":{"description":"The service instance identifier (ip:port)","type":"string","example":"192.168.10.1:21"},"protocol":{"description":"The protocol used","type":"integer","format":"int32","example":6},"performanceScore":{"description":"The overall performance score (0-\u003ehealthy, 100-\u003ecritical)","type":"integer","format":"int32","example":61},"latestPerformanceScore":{"description":"The latest performance score (0-\u003ehealthy, 100-\u003ecritical)","type":"integer","format":"int32","example":0},"nodes":{"description":"List of nodes","type":"array","items":{"type":"string"},"example":["scaleleaf-202"]},"interfaces":{"description":"List of interfaces","type":"array","items":{"type":"string"},"example":["eth1/10"]},"dnsName":{"description":"The DNS name","type":"string","example":"test.cisco.com"},"endpointGroup":{"description":"The endpoint group name","type":"string","example":"ftp_clients"},"endpointSecurityGroup":{"type":"string","description":"The security group associated with the endpoint.","example":"ftp_security_group"},"bridgeDomain":{"description":"The bridge domain name","type":"string","example":"app_bd-1"},"vrfTenant":{"description":"The tenant associated with the VRF","type":"string","example":"tenant1"},"lastUpdated":{"description":"The last update timestamp","type":"string","format":"date-time","example":"2024-07-10T21:05:25.000000Z"},"category":{"description":"The category of the service","type":"string","example":"File_Sharing"},"endpointId":{"description":"The endpoint identifier","type":"string","example":"DC-WEST/tenant1/app_bd-1/1e:e9:a1:98:10:54"},"endpointTenant":{"description":"The tenant associated with the endpoint","type":"string","example":"tenant1"},"endpointVrf":{"description":"The VRF associated with the endpoint","type":"string","example":"app_vrf-1"},"endpointFabricName":{"description":"The name of external fabric if Endpoint is external, otherwise the name of the local fabric","type":"string","example":"DC-WEST"},"vlan":{"description":"The VLAN associated with the endpoint","type":"integer","format":"int32","example":0},"location":{"description":"The endpoint's location is determined by its attachment, if it is connected to a switch within the fabric, the location is considered local; if it is outside any fabric, the location is designated as external.","type":"string","enum":["local","external"],"$$ref":"#/components/schemas/endpointLocation"},"conversationAttributes":{"description":"List of conversation attributes","type":"array","items":{"description":"Enum for conversation attributes","type":"string","enum":["external","l4l7","local","transit"],"$$ref":"#/components/schemas/conversationAttribute"},"example":["external","l4l7","local","transit"]}},"example":{"fabricName":"DC-WEST","tenant":"tenant1","vrf":"app_vrf-1","serviceEndpointIp":"192.168.10.1","serviceEndpointPort":21,"serviceEndpoint":"192.168.10.1:21","protocol":6,"performanceScore":61,"latestPerformanceScore":0,"nodes":["scaleleaf-202"],"interfaces":["eth1/10"],"dnsName":"test.cisco.com","endpointGroup":"ftp_clients","endpointSecurityGroup":"ftp_security_group","bridgeDomain":"app_bd-1","vrfTenant":"tenant1","lastUpdated":"2024-07-10T21:05:25.000000Z","category":"File_Sharing","endpointId":"DC-WEST/tenant1/app_bd-1/1e:e9:a1:98:10:54","endpointTenant":"tenant1","endpointVrf":"app_vrf-1","vlan":10},"$$ref":"#/components/schemas/ServiceEndpointDetails"}}},"description":"OK"},"400":{"description":"Bad Request","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Bad Request","description":"The server could not understand the request due to incorrect syntax.","code":400}}},"$$ref":"#/components/responses/400"},"401":{"description":"Unauthorized","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Unauthorized","description":"Indicates that the request requires user authentication information.","code":401}}},"$$ref":"#/components/responses/401"},"403":{"description":"Forbidden","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Forbidden","description":"The client does not have access rights to the content.","code":403}}},"$$ref":"#/components/responses/403"},"500":{"description":"Internal Server Error","headers":{"Date":{"description":"Date","example":"Tue, 15 Nov 1994 08:12:31 GMT","schema":{"type":"string","example":"Tue, 15 Nov 1994 08:12:31 GMT","nullable":true},"$$ref":"#/components/headers/Date"},"Cache-Control":{"description":"Cache-Control","example":"no-cache, no-store, must-revalidate","schema":{"type":"string","default":"no-cache","nullable":true},"$$ref":"#/components/headers/Cache-Control"}},"content":{"application/json":{"schema":{"description":"Error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"},"errors":{"description":"An array of errors","type":"array","items":{"description":"Sub error object","type":"object","properties":{"message":{"description":"The message that can be displayed to the user","type":"string"},"description":{"description":"A detailed description or suggestions on how to correct the error","type":"string"},"code":{"description":"The error code","type":"integer"}},"required":["message","code","description"],"example":{"message":"Invalid email","description":"The email you provided is invalid","code":4066},"$$ref":"#/components/schemas/SubError"}}},"example":{"message":"Unauthorized","description":"You are not authorized to access this resource","code":4065},"required":["message","code","description"],"$$ref":"#/components/schemas/Error"},"example":{"message":"Internal Server Error","description":"The server encountered an unexpected condition that prevented it from fulfilling the request.","code":500}}},"$$ref":"#/components/responses/500"}},"security":[{"OAuth2":["super-admin","fabric-admin","support-engineer","observer","approver","designer"]}],"summary":"Get Service endpoints details","tags":["Flow Analytics"],"__originalOperationId":"getServicesDetails","method":"get","path":"/traffic/services/details"}}