{ "opencollection": "1.0.0", "info": { "name": "OpenSearch Service Opensearch Cluster API", "version": "20180828" }, "items": [ { "info": { "name": "opensearchCluster", "type": "folder" }, "items": [ { "info": { "name": "List Opensearch Versions", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/opensearch/versions", "params": [ { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." } ] }, "docs": "Lists the supported Opensearch versions\n" }, { "info": { "name": "Gets a list of all OpensearchClusters in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/opensearchClusters", "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 OpensearchClusters their lifecycleState matches the given lifecycleState." }, { "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 OpensearchCluster 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 OpensearchClusters.\n" }, { "info": { "name": "Creates a new OpensearchCluster", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OpensearchCluster.\n" }, { "info": { "name": "Get OpensearchCluster", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ] }, "docs": "Gets a OpensearchCluster by identifier" }, { "info": { "name": "Update the OpensearchCluster identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the OpensearchCluster" }, { "info": { "name": "Delete a provisioned OpensearchCluster", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ] }, "docs": "Deletes a OpensearchCluster resource by identifier" }, { "info": { "name": "Backup the opensearch cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/backup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Backup the opensearch cluster details." }, { "info": { "name": "Configure Outbound cluster for cross-cluster operations", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/configureOutboundCluster", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure Outbound cluster for cross-cluster operations" }, { "info": { "name": "Configure the cluster to work remotely.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/configureRemote", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure the cluster to work remotely." }, { "info": { "name": "Resize the opensearch cluster horizontal details.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/resizeHorizontal", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resize the opensearch cluster horizontal details." }, { "info": { "name": "Resize the opensearch cluster vertical details.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/resizeVertical", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resize the opensearch cluster vertical details." }, { "info": { "name": "Restore the opensearch cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/restore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore the opensearch cluster details." }, { "info": { "name": "Upgrade the opensearch Cluster.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/actions/upgrade", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrade or clone the opensearch cluster." }, { "info": { "name": "Get OpensearchCluster Internal Details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/opensearchClusters/:opensearchClusterId/internal", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "opensearchClusterId", "value": "", "type": "path", "description": "unique OpensearchCluster identifier" } ] }, "docs": "Gets a OpensearchCluster by identifier" }, { "info": { "name": "ListOpensearchClusterShapes", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/shapes" }, "docs": "Retrieves available OpenSearch Cluster node shapes." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "sourceResourceId", "value": "", "type": "query", "description": "The ID of the source resource to list work requests." }, { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }