{ "opencollection": "1.0.0", "info": { "name": "OpenSearch Service Opensearch Cluster Pipeline API", "version": "20180828" }, "items": [ { "info": { "name": "opensearchClusterPipeline", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all OpensearchClusterPipelines in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "pipelineComponentId", "value": "", "type": "query", "description": "A filter to return pipelines whose any component has the given pipelineComponentId." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "unique OpensearchClusterPipeline identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of OpensearchClusterPipelines.\n" }, { "info": { "name": "Creates a new OpensearchCluster Pipeline", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-dry-run", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OpensearchCluster Pipeline.\n" }, { "info": { "name": "Get OpensearchCluster Pipeline", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines/:opensearchClusterPipelineId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterPipelineId", "value": "", "type": "path", "description": "unique OpensearchClusterPipeline identifier" } ] }, "docs": "Gets a OpensearchCluster Pipeline by identifier" }, { "info": { "name": "Update the OpensearchCluster Pipeline identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines/:opensearchClusterPipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-dry-run", "value": "" } ], "params": [ { "name": "opensearchClusterPipelineId", "value": "", "type": "path", "description": "unique OpensearchClusterPipeline identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the OpensearchCluster Pipeline" }, { "info": { "name": "Delete a provisioned OpensearchCluster Pipeline", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines/:opensearchClusterPipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterPipelineId", "value": "", "type": "path", "description": "unique OpensearchClusterPipeline identifier" } ] }, "docs": "Deletes a OpensearchCluster Pipeline resource by identifier" }, { "info": { "name": "Start the pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines/:opensearchClusterPipelineId/actions/startPipeline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterPipelineId", "value": "", "type": "path", "description": "unique OpensearchClusterPipeline identifier" } ] }, "docs": "Start the pipeline.\n" }, { "info": { "name": "Stop the pipeline.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusterPipelines/:opensearchClusterPipelineId/actions/stopPipeline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterPipelineId", "value": "", "type": "path", "description": "unique OpensearchClusterPipeline identifier" } ] }, "docs": "Stop the pipeline.\n" } ] } ], "bundled": true }