clusterMicroServiceList - Crosswork Network Controller 7.2 APIs

{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/aec5c4a2-bcff-3f98-bfdb-2d20859244c1","info":{"title":"Crosswork ClusterManager API","description":"ClusterManager provides API methods for managing Crosswork cluster. This includes getting cluster and node summary, getting cluster and node health information. It also provides APIs to collect showtech, rebalance cluster and set or get login banner.","version":"7.2.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/CLUSTER/cluster-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/platform/v2","description":"Generated server url"}],"securitySchemes":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\""}}},"spec":{"description":"List of Microservices in the Crosswork Cluster","type":"object","properties":{"micro_service":{"description":"Array of Microservice objects","type":"array","items":{"description":"Details of a Microservice in the Crosswork Cluster","type":"object","properties":{"Name":{"description":"Name of the Microservice","type":"string","title":"Name of the Service"},"health_state":{"description":"Health State of the Cluster Component","type":"string","enum":["Healthy","Degraded","Down","NA","Unknown"],"default":"Healthy","$$ref":"#/components/schemas/clusterHealthState"},"up_time":{"description":"Uptime of the Microservice","type":"string","title":"Up time of the Service"},"recommendation":{"description":"Recommendation for the Microservice","type":"string","title":"Recommendation for this Service"},"description":{"description":"Description of the Microservice","type":"string","title":"Description of this Service"},"is_dynamic":{"description":"Indicates if the Microservice is dynamic","type":"boolean","title":"Runtime type of this Service"},"micro_service_action":{"description":"Actions that can be performed on a Microservice","type":"object","properties":{"actions":{"description":"Array of actions that can be performed on a Microservice","type":"array","items":{"description":"Action that can be performed on cluster components","type":"object","properties":{"action_name":{"description":"Name of the action","type":"string"},"action_id":{"description":"Unique identifier for the action","type":"string"}},"example":{"action_name":"Restart","action_id":"RESTART"},"$$ref":"#/components/schemas/clusterAction"}}},"title":"Actions that can be done on a Microservice","$$ref":"#/components/schemas/clusterMicroServiceAction"},"Version":{"description":"Version of the Microservice","type":"string","title":"Version of this service"},"version_history":{"description":"Version history of the Microservice deployment units (Pods)","type":"array","items":{"description":"Version history details of a microservice","type":"object","properties":{"unit_id":{"description":"Immutable Unique application identifier","type":"string","title":"Immutable Unique application identifier"},"version":{"description":"Semantic version of Application containing Major.minor.patch","type":"string","title":"Semantic version of Application containing Major.minor.patch"},"description":{"description":"Description of pod,resource","type":"string","title":"Description of pod,resource"},"creation_time":{"description":"Creation time of the pod","type":"string","format":"int64","title":"Uptime of the pod"}},"title":"Version history of a microservice","$$ref":"#/components/schemas/clusterVersionHistory"},"title":"Deployment unit(Pods) version hsitory"}},"title":"Microservice","$$ref":"#/components/schemas/clusterMicroService"}}},"example":{"micro_service":[{"Name":"cw-views-service","health_state":"Healthy","up_time":"17h 28m 49s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.11","version_history":[]},{"Name":"cw-data-retention-service","health_state":"Healthy","up_time":"17h 27m 8s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.20","version_history":[]},{"Name":"robot-topo-svc","health_state":"Healthy","up_time":"17h 27m 2s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.35","version_history":[]},{"Name":"node-orchestrator","health_state":"Healthy","up_time":"17h 55m 46s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.6","version_history":[]},{"Name":"cw-distributed-cache","health_state":"Healthy","up_time":"17h 32m 49s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.13","version_history":[]},{"Name":"cw-sftp","health_state":"Healthy","up_time":"17h 30m 57s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.4","version_history":[]},{"Name":"cw-timeseries-db","health_state":"Healthy","up_time":"16h 55m 1s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.10","version_history":[]},{"Name":"docker-registry","health_state":"Healthy","up_time":"17h 31m 0s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.5","version_history":[]},{"Name":"robot-ui","health_state":"Healthy","up_time":"17h 26m 34s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.137","version_history":[]},{"Name":"cw-icon-server","health_state":"Healthy","up_time":"17h 26m 13s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.21","version_history":[]},{"Name":"cw-geo-service","health_state":"Healthy","up_time":"17h 26m 51s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.10","version_history":[]},{"Name":"cw-fault-event-processing-service","health_state":"Healthy","up_time":"17h 27m 8s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.26","version_history":[]},{"Name":"robot-orch","health_state":"Healthy","up_time":"17h 49m 30s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.1","version_history":[]},{"Name":"helios","health_state":"Healthy","up_time":"17h 30m 57s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.21","version_history":[]},{"Name":"cw-fault-alarm-rest-service","health_state":"Healthy","up_time":"17h 28m 10s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.28","version_history":[]},{"Name":"astackserver","health_state":"Healthy","up_time":"17h 25m 40s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.8","version_history":[]},{"Name":"local-postgres","health_state":"Healthy","up_time":"17h 50m 31s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.9","version_history":[]},{"Name":"magellan","health_state":"Healthy","up_time":"17h 30m 45s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.16","version_history":[]},{"Name":"cw-proxy","health_state":"Healthy","up_time":"17h 25m 48s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.10","version_history":[]},{"Name":"robot-etcd","health_state":"Healthy","up_time":"17h 55m 42s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.6","version_history":[]},{"Name":"dg-manager","health_state":"Healthy","up_time":"17h 28m 39s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.38","version_history":[]},{"Name":"cas","health_state":"Healthy","up_time":"17h 24m 22s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.34","version_history":[]},{"Name":"nso-fp-dep-mngr","health_state":"Healthy","up_time":"17h 30m 53s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.15","version_history":[]},{"Name":"cw-grouping-service","health_state":"Healthy","up_time":"17h 27m 55s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.15","version_history":[]},{"Name":"cw-ipsec","health_state":"Healthy","up_time":"17h 56m 4s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.5","version_history":[]},{"Name":"nats","health_state":"Healthy","up_time":"17h 50m 34s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.4","version_history":[]},{"Name":"robot-kafka","health_state":"Healthy","up_time":"17h 50m 32s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.7","version_history":[]},{"Name":"topo-restconf-v3","health_state":"Healthy","up_time":"17h 32m 41s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.9","version_history":[]},{"Name":"cw-clms","health_state":"Healthy","up_time":"17h 29m 54s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.32","version_history":[]},{"Name":"cw-fault-alarm-processing-service","health_state":"Healthy","up_time":"17h 28m 33s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.18","version_history":[]},{"Name":"cw-topo-visualization","health_state":"Healthy","up_time":"17h 27m 1s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.25","version_history":[]},{"Name":"tyk","health_state":"Healthy","up_time":"17h 27m 2s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.40","version_history":[]},{"Name":"cw-fault-alarm-forwarding-service","health_state":"Healthy","up_time":"17h 26m 20s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.19","version_history":[]},{"Name":"cw-ftp","health_state":"Healthy","up_time":"17h 30m 57s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.4","version_history":[]},{"Name":"robot-metricmanager","health_state":"Degraded","up_time":"17h 30m 57s","recommendation":"Collect all for tech-support","description":"Error(s) found, click on name to see details. ","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.12","version_history":[]},{"Name":"robot-dlminvmgr","health_state":"Healthy","up_time":"17h 31m 1s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Restart","action_id":"RESTART"},{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.40","version_history":[]},{"Name":"robot-postgres","health_state":"Healthy","up_time":"16h 53m 35s","recommendation":"None","description":"","is_dynamic":false,"micro_service_action":{"actions":[{"action_name":"Request All","action_id":"REQUEST ALL"},{"action_name":"Request Logs","action_id":"REQUEST LOGS"},{"action_name":"Request Metrics","action_id":"REQUEST METRICS"}]},"Version":"7.2.0-prerelease.9","version_history":[]}]},"title":"clusterMicroServiceList","$$ref":"#/components/schemas/clusterMicroServiceList"}}