{ "opencollection": "1.0.0", "info": { "name": "Big Data Service Bds API", "version": "20190531" }, "items": [ { "info": { "name": "bds", "type": "folder" }, "items": [ { "info": { "name": "Create a Bds Capacity Report", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsCapacityReports", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a detailed capacity report for BDS service\n" }, { "info": { "name": "List cluster versions available for creation", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsClusterVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "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": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. If no value is specified bdsVersion is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a list of cluster versions with associated odh and bds versions.\n" }, { "info": { "name": "View the Clusters in a Compartment", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." } ] }, "docs": "Returns a list of all Big Data Service clusters in a compartment.\n" }, { "info": { "name": "Create a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Big Data Service cluster.\n" }, { "info": { "name": "View a Cluster", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ] }, "docs": "Returns information about the Big Data Service cluster identified by the given ID." }, { "info": { "name": "Update a Cluster", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Big Data Service cluster identified by the given ID." }, { "info": { "name": "Delete a Cluster", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ] }, "docs": "Deletes the cluster identified by the given ID." }, { "info": { "name": "Add Block Storage to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/addBlockStorage", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.\n" }, { "info": { "name": "Add Cloud SQL to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/addCloudSql", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.\n" }, { "info": { "name": "Add Kafka to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/addKafka", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds Kafka to a cluster.\n" }, { "info": { "name": "Add Master Nodes to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/addMasterNodes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increases the size (scales out) of a cluster by adding master nodes. The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster.\n" }, { "info": { "name": "Add Utility Nodes to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/addUtilityNodes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increases the size (scales out) of a cluster by adding utility nodes. The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster.\n" }, { "info": { "name": "Add Worker Nodes to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/addWorkerNodes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increases the size (scales out) of a cluster by adding worker nodes (data/compute/edge). The added worker and compute only worker nodes will have the same amount of attached block storage as other nodes of the same type in the cluster. Edge nodes can have different block storage sizes within the valid range (50GB-10TB).\n" }, { "info": { "name": "Takes the backup of given nodes.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/backupNodes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Takes a backup of of given nodes.\n" }, { "info": { "name": "Move a Cluster to a Different Compartment", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Big Data Service cluster into a different compartment.\n" }, { "info": { "name": "Resize a Cluster by Changing Node Shapes", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/changeShape", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.\n" }, { "info": { "name": "Disabling TLS/SSL Encryption for ODH Services.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/disableOdhServiceCertificate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disabling TLS/SSL for various ODH services running on the BDS cluster.\n" }, { "info": { "name": "Configuring TLS/SSL Encryption for ODH Services.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/enableOdhServiceCertificate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configuring TLS/SSL for various ODH services running on the BDS cluster.\n" }, { "info": { "name": "Execute bootstrap script.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/executeBootstrapScript", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute bootstrap script.\n" }, { "info": { "name": "A list of services and their certificate details.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/fetchOdhServiceCertificate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A list of services and their certificate details.\n" }, { "info": { "name": "Generating certificates under BDS cluster nodes.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/generateBdsCertificate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generating certificates under BDS cluster nodes.\n" }, { "info": { "name": "GetOsPatchDetails", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/getOsPatch", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "osPatchVersion", "value": "", "type": "query", "description": "The version of the OS patch." } ] }, "docs": "Get the details of an os patch" }, { "info": { "name": "InstallOsPatch", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/installOsPatch", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Install an os patch on a cluster\n" }, { "info": { "name": "Install the specified patch to this cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/installPatch", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Install the specified patch to this cluster.\n" }, { "info": { "name": "Install the specified software update to this cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/installSoftwareUpdates", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Install the specified software update to this cluster.\n" }, { "info": { "name": "ListOsPatches", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/listOsPatches", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "List all available os patches for a given cluster" }, { "info": { "name": "Remove Cloud SQL from a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/removeCloudSql", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes Cloud SQL from the cluster.\n" }, { "info": { "name": "Remove Kafka from the cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/removeKafka", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Kafka from the cluster.\n" }, { "info": { "name": "Remove a Node", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/removeNode", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a single node of a Big Data Service cluster\n" }, { "info": { "name": "Remove multiple Nodes", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/removeNodes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes list of nodes from a Big Data Service cluster\n" }, { "info": { "name": "Renewing certificates under BDS cluster nodes.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/renewBdsCertificate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renewing certificates under BDS cluster nodes.\n" }, { "info": { "name": "Renewing TLS/SSL Encryption for ODH Services.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/renewOdhServiceCertificate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renewing TLS/SSL for various ODH services running on the BDS cluster.\n" }, { "info": { "name": "Replace a failed node using its backup.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/replaceNode", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces a node of a Big Data Service cluster from backup.\n" }, { "info": { "name": "Reset the indicated service's password.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/resetPassword", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Admin function which allows the password reset of indicated service.\n" }, { "info": { "name": "Restart a Node", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/restartNode", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restarts a single node of a Big Data Service cluster\n" }, { "info": { "name": "Starts the BDS cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/start", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts the BDS cluster that was stopped earlier.\n" }, { "info": { "name": "Stops the BDS cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/actions/stop", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stops the BDS cluster that can be started at later point of time.\n" }, { "info": { "name": "View all API keys associated with this Big Data Service cluster.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/apiKeys", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the API key." }, { "name": "userId", "value": "", "type": "query", "description": "The OCID of the user for whom the API key belongs." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." } ] }, "docs": "Returns a list of all API keys associated with this Big Data Service cluster.\n" }, { "info": { "name": "Create a user API key.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/apiKeys", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an API key on behalf of the specified user.\n" }, { "info": { "name": "View user's API key information.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/apiKeys/:apiKeyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "apiKeyId", "value": "", "type": "path", "description": "The API key identifier." } ] }, "docs": "Returns the user's API key information for the given ID." }, { "info": { "name": "Delete a user's API key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId/apiKeys/:apiKeyId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "apiKeyId", "value": "", "type": "path", "description": "The API key identifier." } ] }, "docs": "Deletes the user's API key represented by the provided ID." }, { "info": { "name": "Test access to specified Object Storage bucket.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/apiKeys/:apiKeyId/actions/testObjectStorageConnection", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "apiKeyId", "value": "", "type": "path", "description": "The API key identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test access to specified Object Storage bucket using the API key." }, { "info": { "name": "View Autoscale Configurations", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/autoScalingConfiguration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the autoscale configuration." } ] }, "docs": "Returns information about the autoscaling configurations for a cluster.\n" }, { "info": { "name": "Add an Autoscale Configuration to a Cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/autoScalingConfiguration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an autoscale configuration to the cluster.\n" }, { "info": { "name": "View Details of an Autoscale Configuration", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/autoScalingConfiguration/:autoScalingConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the autoscale configuration." } ] }, "docs": "Returns details of the autoscale configuration identified by the given ID.\n" }, { "info": { "name": "Modify an Autoscale Configuration", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId/autoScalingConfiguration/:autoScalingConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the autoscale configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.\n" }, { "info": { "name": "Delete an Autoscale Configuration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/autoScalingConfiguration/:autoScalingConfigurationId/actions/remove", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "autoScalingConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the autoscale configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an autoscale configuration.\n" }, { "info": { "name": "View all BDS certificate configurations associated with this Big Data Service cluster.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/bdsCertificateConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the BdsCertificateConfiguration." } ] }, "docs": "Returns a list of BDS certificate configurations associated with this Big Data Service cluster.\n" }, { "info": { "name": "Create a BDS certificate configuration for the cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/bdsCertificateConfigurations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a BDS certificate configuration for the cluster.\n" }, { "info": { "name": "View Details of the indicated BdsCertificateConfiguration", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/bdsCertificateConfigurations/:bdsCertificateConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "bdsCertificateConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the BdsCertificateConfiguration." } ] }, "docs": "Returns details of the BdsCertificateConfiguration identified by the given ID.\n" }, { "info": { "name": "Delete the BDS certificate configuration for the given ID.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId/bdsCertificateConfigurations/:bdsCertificateConfigurationId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "bdsCertificateConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the BdsCertificateConfiguration." } ] }, "docs": "Delete the BDS certificate configuration for the given ID." }, { "info": { "name": "Set specified BDS certificate configuration as default configuration.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/bdsCertificateConfigurations/:bdsCertificateConfigurationId/actions/setDefault", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "bdsCertificateConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the BdsCertificateConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set specified BDS certificate configuration as default configuration.\n" }, { "info": { "name": "View all identity configurations associated with this Big Data Service cluster.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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 OCID of the compartment." }, { "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the identity config" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." } ] }, "docs": "Returns a list of all identity configurations associated with this Big Data Service cluster.\n" }, { "info": { "name": "Create an identity configuration for the cluster", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an identity configuration for the cluster" }, { "info": { "name": "Get details of one identity config on the cluster", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Get details of one identity config on the cluster" }, { "info": { "name": "Update the IAM user sync and UPST configuration for the specified identity configuration", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the IAM user sync and UPST configuration for the specified identity configuration" }, { "info": { "name": "Delete the specified identity configuration", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ] }, "docs": "Delete the identity configuration represented by the provided ID. Deletion is only allowed if this identity configuration is not associated with any active IAM user sync configuration or UPST configuration." }, { "info": { "name": "Activate IAM user sync configuration for the given identity configuration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId/actions/activateIamUserSyncConfiguration", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate IAM user sync configuration for the given identity configuration" }, { "info": { "name": "Activate UPST configuration for the given identity configuration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId/actions/activateUpstConfiguration", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate UPST configuration for the given identity configuration" }, { "info": { "name": "Deactivate the specified IAM user sync configuration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId/actions/deactivateIamUserSyncConfiguration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deactivate the IAM user sync configuration." }, { "info": { "name": "Deactivate the specified UPST configuration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId/actions/deactivateUpstConfiguration", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deactivate the UPST configuration represented by the provided ID." }, { "info": { "name": "Refresh confidential application", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId/actions/refreshConfidentialApplication", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refresh confidential application for the given identity configuration in case of any update to the confidential application (e.g. regenerated client secret)" }, { "info": { "name": "Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/identityConfigurations/:identityConfigurationId/actions/refreshUpstTokenExchangeKeytab", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "identityConfigurationId", "value": "", "type": "path", "description": "The OCID of the identity configuration" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration" }, { "info": { "name": "View all metastore configurations associated with this Big Data Service cluster.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "metastoreType", "value": "", "type": "query", "description": "The type of the metastore in the metastore configuration" }, { "name": "metastoreId", "value": "", "type": "query", "description": "The OCID of the Data Catalog metastore in the metastore configuration" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the metastore in the metastore configuration" }, { "name": "bdsApiKeyId", "value": "", "type": "query", "description": "The ID of the API key that is associated with the external metastore in the metastore configuration" }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." } ] }, "docs": "Returns a list of metastore configurations ssociated with this Big Data Service cluster.\n" }, { "info": { "name": "Create and activate external metastore configuration.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create and activate external metastore configuration.\n" }, { "info": { "name": "View BDS Metastore configuration information.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs/:metastoreConfigId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "metastoreConfigId", "value": "", "type": "path", "description": "The metastore configuration ID" } ] }, "docs": "Returns the BDS Metastore configuration information for the given ID." }, { "info": { "name": "Update a BDS metastore configuration.", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs/:metastoreConfigId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "metastoreConfigId", "value": "", "type": "path", "description": "The metastore configuration ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the BDS metastore configuration represented by the provided ID." }, { "info": { "name": "Delete a BDS metastore configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs/:metastoreConfigId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "metastoreConfigId", "value": "", "type": "path", "description": "The metastore configuration ID" } ] }, "docs": "Delete the BDS metastore configuration represented by the provided ID." }, { "info": { "name": "Activate specified metastore configuration.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs/:metastoreConfigId/actions/activate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "metastoreConfigId", "value": "", "type": "path", "description": "The metastore configuration ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activate specified metastore configuration.\n" }, { "info": { "name": "Test specified metastore configuration.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/metastoreConfigs/:metastoreConfigId/actions/test", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "metastoreConfigId", "value": "", "type": "path", "description": "The metastore configuration ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test specified metastore configuration.\n" }, { "info": { "name": "View the list of NodeBackupConfigurations", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackupConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the NodeBackupConfiguration configuration." } ] }, "docs": "Returns information about the NodeBackupConfigurations.\n" }, { "info": { "name": "Add a nodeBackupConfiguration to the indicated BDS Cluster for an indicated node type or node.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackupConfigurations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a node volume backup configuration to the cluster for an indicated node type or node.\n" }, { "info": { "name": "View Details of the indicated NodeBackupConfiguration", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackupConfigurations/:nodeBackupConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeBackupConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the NodeBackupConfiguration." } ] }, "docs": "Returns details of the NodeBackupConfiguration identified by the given ID.\n" }, { "info": { "name": "Modify a NodeBackupConfiguration", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackupConfigurations/:nodeBackupConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeBackupConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the NodeBackupConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates fields on NodeBackupConfiguration, including the name, the schedule.\n" }, { "info": { "name": "Delete a NodeBackupConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackupConfigurations/:nodeBackupConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeBackupConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the NodeBackupConfiguration." } ] }, "docs": "Delete the NodeBackupConfiguration represented by the provided ID." }, { "info": { "name": "View List of NodeBackups", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "nodeHostName", "value": "", "type": "query", "description": "The node host name belonged to a node that has a node backup." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the Node's Backup." }, { "name": "displayName", "value": "", "type": "query", "description": "The display name belonged to the node backup." } ] }, "docs": "Returns information about the node Backups.\n" }, { "info": { "name": "View Details of NodeBackup", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackups/:nodeBackupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeBackupId", "value": "", "type": "path", "description": "Unique assigned identifier of the nodeBackupId." } ] }, "docs": "Returns details of NodeBackup identified by the given ID.\n" }, { "info": { "name": "Delete a NodeBackup", "type": "http" }, "http": { "method": "DELETE", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeBackups/:nodeBackupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeBackupId", "value": "", "type": "path", "description": "Unique assigned identifier of the nodeBackupId." } ] }, "docs": "Delete the NodeBackup represented by the provided ID." }, { "info": { "name": "View the list of NodeReplaceConfigurations", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeReplaceConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the NodeReplaceConfiguration." } ] }, "docs": "Returns information about the NodeReplaceConfiguration.\n" }, { "info": { "name": "Add nodeReplaceConfiguration to the BDS Cluster for a node type.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeReplaceConfigurations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a nodeReplaceConfigurations to the cluster.\n" }, { "info": { "name": "View Details of the indicated nodeReplaceConfiguration", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeReplaceConfigurations/:nodeReplaceConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeReplaceConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the NodeReplaceConfiguration." } ] }, "docs": "Returns details of the nodeReplaceConfiguration identified by the given ID.\n" }, { "info": { "name": "Modify a nodeReplaceConfigurations", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeReplaceConfigurations/:nodeReplaceConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeReplaceConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the NodeReplaceConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates fields on nodeReplaceConfigurations, including the name, the schedule\n" }, { "info": { "name": "Delete a nodeReplaceConfiguration", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/nodeReplaceConfigurations/:nodeReplaceConfigurationId/actions/remove", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "nodeReplaceConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the NodeReplaceConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a nodeReplaceConfiguration\n" }, { "info": { "name": "List the patch history of this cluster.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/patchHistory", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The status of the patch." }, { "name": "patchVersion", "value": "", "type": "query", "description": "The version of the patch" }, { "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "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": "patchType", "value": "", "type": "query", "description": "The type of a BDS patch history entity." } ] }, "docs": "List the patch history of this cluster.\n" }, { "info": { "name": "List all the available patches for this cluster.", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/patches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "List all the available patches for this cluster.\n" }, { "info": { "name": "View the list of ResourcePrincipalConfigurations", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/resourcePrincipalConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the ResourcePrincipalConfiguration." } ] }, "docs": "Returns information about the ResourcePrincipalConfiguration.\n" }, { "info": { "name": "Create a resource principal configuration for the cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/resourcePrincipalConfigurations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a resource principal session token configuration.\n" }, { "info": { "name": "View Details of the indicated resourcePrincipalConfiguration", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/resourcePrincipalConfigurations/:resourcePrincipalConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "resourcePrincipalConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration." } ] }, "docs": "Returns details of the resourcePrincipalConfiguration identified by the given ID.\n" }, { "info": { "name": "Modify a resourcePrincipalConfiguration", "type": "http" }, "http": { "method": "PUT", "url": "/20190531/bdsInstances/:bdsInstanceId/resourcePrincipalConfigurations/:resourcePrincipalConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "resourcePrincipalConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token.\n" }, { "info": { "name": "Force Refresh Resource Principal for the cluster.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/resourcePrincipalConfigurations/:resourcePrincipalConfigurationId/actions/forceRefreshResourcePrincipal", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "resourcePrincipalConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Force Refresh Resource Principal for the cluster.\n" }, { "info": { "name": "Delete a ResourcePrincipalConfiguration.", "type": "http" }, "http": { "method": "POST", "url": "/20190531/bdsInstances/:bdsInstanceId/resourcePrincipalConfigurations/:resourcePrincipalConfigurationId/actions/remove", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "resourcePrincipalConfigurationId", "value": "", "type": "path", "description": "Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete the resource principal configuration for the cluster.\n" }, { "info": { "name": "ListSoftwareUpdates", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/softwareUpdates", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "List all the available software updates for current cluster." }, { "info": { "name": "GetSoftwareUpdate", "type": "http" }, "http": { "method": "GET", "url": "/20190531/bdsInstances/:bdsInstanceId/softwareUpdates/:softwareUpdateKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "bdsInstanceId", "value": "", "type": "path", "description": "The OCID of the cluster." }, { "name": "softwareUpdateKey", "value": "", "type": "path", "description": "The unique identifier of the software update." } ] }, "docs": "Get the details of the software update of the given SoftwareUpdateId\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "/20190531/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "resourceId", "value": "", "type": "query", "description": "The OCID of the resource." }, { "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": "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "View the Status of a Work Request", "type": "http" }, "http": { "method": "GET", "url": "/20190531/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Returns the status of the work request identified by the given ID." }, { "info": { "name": "List Work Request Errors", "type": "http" }, "http": { "method": "GET", "url": "/20190531/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." }, { "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a paginated list of errors for a work request identified by the given ID.\n" }, { "info": { "name": "List Work Request Logs", "type": "http" }, "http": { "method": "GET", "url": "/20190531/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." }, { "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" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a paginated list of logs for a given work request.\n" } ] } ], "bundled": true }