{"type":"api","title":"Get crosswork dc node list Summary","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":{"summary":"Get crosswork dc node list Summary","description":"Get crosswork dc node list Summary, node resource and actions","operationId":"ClusterManager_GetDCListSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"description":"Summary of Data Center List in the Crosswork Cluster","type":"object","properties":{"dc_summary":{"description":"Array of data center summaries","type":"array","items":{"description":"Summary of a Data Center in the Crosswork Cluster","type":"object","properties":{"node_summary":{"description":"Array of node summaries in the data center","type":"array","items":{"description":"Summary of Crosswork Node","type":"object","properties":{"node_name":{"description":"Name of the node","type":"string"},"node_id":{"description":"Identifier of the node","type":"string"},"node_health":{"description":"Health State of the Cluster Component","type":"string","enum":["Healthy","Degraded","Down","NA","Unknown"],"default":"Healthy","$$ref":"#/components/schemas/clusterHealthState"},"node_type":{"description":"Type of the node","type":"string"},"vm_name":{"description":"Name of the VM","type":"string"},"node_resource":{"description":"Resource Health Summary","type":"object","properties":{"cpu_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"memory_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"disk_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"node_cpu_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"node_mem_summary":{"description":"Summary of Crosswork Resources","type":"object","properties":{"current_usage":{"description":"Current resource usage in percent","type":"string"},"used":{"description":"Amount of resource used","type":"string"},"total":{"description":"Total amount of resource available","type":"string"},"thresholds":{"description":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","type":"object","properties":{"medium_range_start":{"description":"Medium range start threshold in percent","type":"integer","format":"int32"},"high_range_start":{"description":"High range start threshold in percent","type":"integer","format":"int32"}},"title":"Usage Thresholds in percent for CPU, Memory or Disk\nLow : 0 - \u003c medium_range_start\nMedium : medium_range_start - \u003c high_range_start\nHigh : high_range_start - 100","$$ref":"#/components/schemas/clusterResourceThreshold"}},"title":"Summary of Crosswork Resources","$$ref":"#/components/schemas/clusterResourceSummary"},"last_updated_time":{"description":"Last updated time of the resource summary","type":"string"}},"example":{"cpu_summary":{"current_usage":"38 %","used":"4.58 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"23.07 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.44 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 15:10:25 UTC"},"$$ref":"#/components/schemas/clusterResource"},"actions":{"description":"Actions that can be performed on the node","type":"object","additionalProperties":{"type":"boolean"}},"vm_state":{"description":"State of the VM","type":"string"},"vm_id":{"description":"Identifier of the VM","type":"string"},"availability":{"description":"High-Availability status of the node","type":"string"},"recommendation_available":{"description":"Indicates if a recommendation is available for the node","type":"boolean"},"vm_os_version":{"description":"Operating system version of the VM","type":"string"}},"example":{"node_name":"192-168-133-165-hybrid.cw.cisco","node_id":"192.168.133.165","node_health":"Healthy","node_type":"HYBRID","vm_name":"svm1-az1","node_resource":{"cpu_summary":{"current_usage":"39 %","used":"4.71 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"23.05 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.43 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 15:00:25 UTC"},"actions":{"cancelJob":false,"deployVM":false,"eraseVM":false,"retry":false,"viewDetails":true},"vm_state":"Running","vm_id":"0","availability":"Not protected","recommendation_available":false,"vm_os_version":"base-cw-image-v7.2.0"},"title":"Summary of Crosswork Node","$$ref":"#/components/schemas/clusterNodeSummary"}},"dc_name":{"description":"Name of the Data Center","type":"string"},"dc_id":{"description":"Identifier of the Data Center","type":"string"}},"example":{"node_summary":[{"node_name":"192-168-133-165-hybrid.cw.cisco","node_id":"192.168.133.165","node_health":"Healthy","node_type":"HYBRID","vm_name":"svm1-az1","node_resource":{"cpu_summary":{"current_usage":"39 %","used":"4.68 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"22.98 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.53 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 14:50:25 UTC"},"actions":{"cancelJob":false,"deployVM":false,"eraseVM":false,"retry":false,"viewDetails":true},"vm_state":"Running","vm_id":"0","availability":"Not protected","recommendation_available":false,"vm_os_version":"base-cw-image-v7.2.0"}],"dc_name":"DC1","dc_id":"DC1"},"title":"Summary of DC","$$ref":"#/components/schemas/clusterDCSummary"}}},"example":{"dc_summary":[{"node_summary":[{"node_name":"192-168-133-165-hybrid.cw.cisco","node_id":"192.168.133.165","node_health":"Healthy","node_type":"HYBRID","vm_name":"svm1-az1","node_resource":{"cpu_summary":{"current_usage":"39 %","used":"4.68 cores","total":"12.00 cores","thresholds":{"medium_range_start":60,"high_range_start":90}},"memory_summary":{"current_usage":"24 %","used":"22.98 GB","total":"94.29 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"disk_summary":{"current_usage":"5 %","used":"47.53 GB","total":"0.00 GB","thresholds":{"medium_range_start":60,"high_range_start":90}},"node_cpu_summary":{"current_usage":"49 %","used":"5.41 cores","total":"11.00 cores","thresholds":{"medium_range_start":98,"high_range_start":99}},"node_mem_summary":{"current_usage":"22 %","used":"21660434432.00 B","total":"97547956224.00 B","thresholds":{"medium_range_start":98,"high_range_start":99}},"last_updated_time":"Wednesday, 05-Mar-25 14:50:25 UTC"},"actions":{"cancelJob":false,"deployVM":false,"eraseVM":false,"retry":false,"viewDetails":true},"vm_state":"Running","vm_id":"0","availability":"Not protected","recommendation_available":false,"vm_os_version":"base-cw-image-v7.2.0"}],"dc_name":"DC1","dc_id":"DC1"}]},"title":"Summary of DC List","$$ref":"#/components/schemas/clusterDCListSummary"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"description":"The `Error` message provides a standardized way to represent error details in API responses.\nIt is designed to be flexible and extensible, allowing for the inclusion of additional information\nas needed.","type":"object","properties":{"error":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n`details` field, or localized by the client.","type":"string"},"code":{"description":"A numeric code that should be understood and handled by the client.\nThe code should not change across different instances of the\nsame error, unless there is a breaking change in the API.\n\nThe numeric codes are defined in [google.rpc.Code][].","type":"integer","format":"int32"},"message":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n`details` field, or localized by the client.","type":"string"},"details":{"description":"A list of messages that carry the error details. There is a\ncommon set of message types for APIs to use.\n\nThe values for Object must be JSON objects. If a different\nvalue is needed, a custom type must be defined. See\n[google.protobuf.Any][] for more information.","type":"array","items":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","format":"byte","description":"Must be a valid serialized protocol buffer of the above specified type."}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","$$ref":"#/components/schemas/protobufAny"}}},"example":{"error":"error message","code":2,"message":"error message","details":[]},"$$ref":"#/components/schemas/gatewayruntimeError"}}}}},"tags":["ClusterManager"],"__originalOperationId":"ClusterManager_GetDCListSummary","security":[{"bearerAuth":[]}],"method":"get","path":"/cluster/dc/summary/list"}}