{ "opencollection": "1.0.0", "info": { "name": "Analytics API", "version": "20190331" }, "items": [ { "info": { "name": "analytics", "type": "folder" }, "items": [ { "info": { "name": "List Analytics instances.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/analyticsInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the given name exactly.\n" }, { "name": "capacityType", "value": "", "type": "query", "description": "A filter to only return resources matching the capacity type enum. Values are\ncase-insensitive.\n" }, { "name": "featureSet", "value": "", "type": "query", "description": "A filter to only return resources matching the feature set. Values are\ncase-insensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources matching the lifecycle state. The state\nvalue is case-insensitive.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by (one column only). Default sort order is\nascending exception of `timeCreated` column (descending).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "List Analytics instances.\n" }, { "info": { "name": "Create an Analytics instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new AnalyticsInstance in the specified compartment. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Retrieve Analytics instance metadata.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/analyticsInstances/:analyticsInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ] }, "docs": "Info for a specific Analytics instance.\n" }, { "info": { "name": "Update an Analytics instance.", "type": "http" }, "http": { "method": "PUT", "url": "/20190331/analyticsInstances/:analyticsInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates certain fields of an Analytics instance. Fields that are not provided in the\nrequest will not be updated.\n" }, { "info": { "name": "Delete an Analytics instance.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190331/analyticsInstances/:analyticsInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ] }, "docs": "Terminates the specified Analytics instance. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Change the compartment of an Analytics instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the compartment of an Analytics instance. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Change an Analytics instance network endpoint.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/changeNetworkEndpoint", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change an Analytics instance network endpoint. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Scale an Analytics instance up or down.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/scale", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scale an Analytics instance up or down. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Set the feature bundle of an Analytics instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/setFeatureBundle", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the external service properties of an Analytics instance.\n" }, { "info": { "name": "Encrypts customer data with an OCI Vault key or reverts back to Oracle managed key.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/setKmsKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.\n" }, { "info": { "name": "Starts the specified Analytics instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ] }, "docs": "Starts the specified Analytics instance. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Stop the specified Analytics instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ] }, "docs": "Stop the specified Analytics instance. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Create a Private access Channel for the Analytics instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/privateAccessChannels", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Private access Channel for the Analytics instance. The operation is long-running\nand creates a new WorkRequest.\n" }, { "info": { "name": "Retrieve private access channel in the specified Analytics Instance.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/analyticsInstances/:analyticsInstanceId/privateAccessChannels/:privateAccessChannelKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateAccessChannelKey", "value": "", "type": "path", "description": "The unique identifier key of the Private Access Channel.\n" }, { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ] }, "docs": "Retrieve private access channel in the specified Analytics Instance.\n" }, { "info": { "name": "Update the Private Access Channel.", "type": "http" }, "http": { "method": "PUT", "url": "/20190331/analyticsInstances/:analyticsInstanceId/privateAccessChannels/:privateAccessChannelKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "privateAccessChannelKey", "value": "", "type": "path", "description": "The unique identifier key of the Private Access Channel.\n" }, { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.\n" }, { "info": { "name": "Delete an Analytics instance's Private access channel with the given unique identifier key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190331/analyticsInstances/:analyticsInstanceId/privateAccessChannels/:privateAccessChannelKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "privateAccessChannelKey", "value": "", "type": "path", "description": "The unique identifier key of the Private Access Channel.\n" }, { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ] }, "docs": "Delete an Analytics instance's Private access channel with the given unique identifier key.\n" }, { "info": { "name": "Create a vanity URL for the Analytics Instance.", "type": "http" }, "http": { "method": "POST", "url": "/20190331/analyticsInstances/:analyticsInstanceId/vanityUrls", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate\nfor this host.\n" }, { "info": { "name": "Upload a new certificate for a vanity url.", "type": "http" }, "http": { "method": "PUT", "url": "/20190331/analyticsInstances/:analyticsInstanceId/vanityUrls/:vanityUrlKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" }, { "name": "vanityUrlKey", "value": "", "type": "path", "description": "Specify unique identifier key of a vanity url to update or delete.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.\n" }, { "info": { "name": "Delete a vanity URL for the Analytics Instance.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190331/analyticsInstances/:analyticsInstanceId/vanityUrls/:vanityUrlKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "analyticsInstanceId", "value": "", "type": "path", "description": "The OCID of the AnalyticsInstance.\n" }, { "name": "vanityUrlKey", "value": "", "type": "path", "description": "Specify unique identifier key of a vanity url to update or delete.\n" } ] }, "docs": "Allows deleting a previously created vanity url.\n" }, { "info": { "name": "List all work requests.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The OCID of the resource associated with a work request.\n" }, { "name": "resourceType", "value": "", "type": "query", "description": "Type of the resource associated with a work request.\n" }, { "name": "status", "value": "", "type": "query", "description": "One or more work request status values to filter on.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used for sorting work request results.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n" } ] }, "docs": "List all work requests in a compartment.\n" }, { "info": { "name": "Get work request details.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request.\n" } ] }, "docs": "Get the details of a work request.\n" }, { "info": { "name": "Cancel a work request.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190331/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request.\n" } ] }, "docs": "Cancel a work request that has not started yet.\n" }, { "info": { "name": "Get work request errors.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Get the errors of a work request.\n" }, { "info": { "name": "Get work request logs.", "type": "http" }, "http": { "method": "GET", "url": "/20190331/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Get the logs of a work request.\n" } ] } ], "bundled": true }