Trigger showtech collection job - Crosswork Network Controller 7.2 APIs

{"type":"api","title":"Trigger showtech collection job","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":"Trigger showtech collection job","description":"Showtech Collection APIs ( backward compatibility wrt to req/response)\nInitiate collection of data for troubleshooting Crosswork Platform applications. Collection jobs can be scoped to a specific app or type.","operationId":"ClusterManager_RequestCollectJobs","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"description":"Response for collection job information request","type":"object","properties":{"Result":{"description":"ResultValue indicates the outcome of an operation","type":"string","enum":["NOOP","SUCCESS","FAILURE"],"default":"NOOP","$$ref":"#/components/schemas/clusterResultValue"},"Description":{"description":"Additional information regarding the response","type":"string","title":"Additional information regarding the response"},"CollectJobs":{"description":"Array of collection job objects","type":"array","items":{"description":"Details of collect job","type":"object","properties":{"Id":{"description":"Unique identifier for the collect job","type":"string","title":"Unique Collect Job Id"},"JobScope":{"description":"Scope of the collect job","type":"string"},"Type":{"description":"Type of collection job to be performed","type":"string","enum":["_","All","Logs","Metrics"],"default":"_","$$ref":"#/components/schemas/clusterCollectType"},"JobStatus":{"description":"Status of an asynchronous job","type":"string","enum":["JobUnknown","JobCreated","JobInProgress","JobCompleted","JobFailed"],"default":"JobUnknown","$$ref":"#/components/schemas/clusterjobStatus"},"User":{"description":"User who initiated the collect job","type":"string"},"CreationTime":{"description":"Timestamp when the collect job was created","type":"string"},"Description":{"description":"Additional information regarding the collect job","type":"string","title":"Additional information regarding the job"},"CompletionTime":{"description":"Timestamp when the collect job was completed","type":"string"},"IsPurged":{"description":"Indicates whether the collect job has been purged","type":"boolean"}},"$$ref":"#/components/schemas/CollectOpResultcollectJob"}}},"example":{"Result":"SUCCESS","Description":"","CollectJobs":[{"Id":"20250305124702","JobScope":"All","Type":"All","JobStatus":"JobInProgress","User":"admin","CreationTime":"2025-03-05T12:47:02Z","Description":"Job in progress. Progress completed: 97.4%","CompletionTime":"","IsPurged":false}]},"$$ref":"#/components/schemas/clusterCollectOpResult"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Request to start a collection job in the Crosswork Cluster","type":"object","properties":{"JobScope":{"type":"string","description":"OPTIONAL: Scope of collection job, i.e. name of service for which job is to be run. Defaults to all apps and services."},"Type":{"description":"Type of collection job to be performed","type":"string","enum":["_","All","Logs","Metrics"],"default":"_","$$ref":"#/components/schemas/clusterCollectType"},"Timeout":{"description":"OPTIONAL: Timeout for the collection job. Default is 30m. Format is as per time.ParseDuration","type":"string","title":"OPTIONAL: Timeout is using time.ParseDuration that takes 30m for 30 minutes, 60s for 60 seconds"}},"example":{"JobScope":"All","Type":"All","Timeout":"30m"},"$$ref":"#/components/schemas/clusterCollectReq"}}},"description":"Showtech Collection APIs ( backward compatibility wrt to req/response)\nInitiate collection of data for troubleshooting Crosswork Platform applications. Collection jobs can be scoped to a specific app or type.","required":true},"tags":["ClusterManager"],"__originalOperationId":"ClusterManager_RequestCollectJobs","security":[{"bearerAuth":[]}],"method":"post","path":"/cluster/collect/start/query"}}