{ "opencollection": "1.0.0", "info": { "name": "Streaming Stream Admin API", "version": "20180418" }, "items": [ { "info": { "name": "streamAdmin", "type": "folder" }, "items": [ { "info": { "name": "Lists the connectharnesses.", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/connectharnesses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the given ID exactly.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the given name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. The value must be between 1 and 50. The default is 10." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the connectharness." }, { "info": { "name": "Create a connect harness", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/connectharnesses", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts the provisioning of a new connect harness.\nTo track the progress of the provisioning, you can periodically call [GetConnectHarness].\nIn the response, the `lifecycleState` parameter of the [ConnectHarness](#/en/streaming/20180418/ConnectHarness/) object tells you its current state.\n" }, { "info": { "name": "Gets a connectharness", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/connectharnesses/:connectHarnessId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectHarnessId", "value": "", "type": "path", "description": "The OCID of the connect harness.\n" } ] }, "docs": "Gets detailed information about a connect harness." }, { "info": { "name": "Updates a connect harness.", "type": "http" }, "http": { "method": "PUT", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/connectharnesses/:connectHarnessId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectHarnessId", "value": "", "type": "path", "description": "The OCID of the connect harness.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the tags applied to the connect harness.\n" }, { "info": { "name": "Deletes a connect harness.", "type": "http" }, "http": { "method": "DELETE", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/connectharnesses/:connectHarnessId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "connectHarnessId", "value": "", "type": "path", "description": "The OCID of the connect harness.\n" } ] }, "docs": "Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations.\nTo verify that a connect harness has been deleted, make a [GetConnectHarness](#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call retur" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/connectharnesses/:connectHarnessId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectHarnessId", "value": "", "type": "path", "description": "The OCID of the connect harness.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "List the stream pools for a given compartment ID.", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streampools", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the given ID exactly.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the given name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. The value must be between 1 and 50. The default is 10." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "List the stream pools for a given compartment ID." }, { "info": { "name": "Creates a stream pool.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streampools", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts the provisioning of a new stream pool.\nTo track the progress of the provisioning, you can periodically call GetStreamPool.\nIn the response, the `lifecycleState` parameter of the object tells you its current state.\n" }, { "info": { "name": "Gets the stream pool", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streampools/:streamPoolId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamPoolId", "value": "", "type": "path", "description": "The OCID of the stream pool.\n" } ] }, "docs": "Gets detailed information about the stream pool, such as Kafka settings." }, { "info": { "name": "Updates the stream pool.", "type": "http" }, "http": { "method": "PUT", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streampools/:streamPoolId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "streamPoolId", "value": "", "type": "path", "description": "The OCID of the stream pool.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified stream pool.\n" }, { "info": { "name": "Deletes a stream pool.", "type": "http" }, "http": { "method": "DELETE", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streampools/:streamPoolId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "streamPoolId", "value": "", "type": "path", "description": "The OCID of the stream pool.\n" } ] }, "docs": "Deletes a stream pool. All containing streams will also be deleted.\nThe default stream pool of a compartment cannot be deleted.\n" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streampools/:streamPoolId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamPoolId", "value": "", "type": "path", "description": "The OCID of the stream pool.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Lists the streams in the given compartment id.", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required." }, { "name": "streamPoolId", "value": "", "type": "query", "description": "The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources that match the given ID exactly.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the given name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. The value must be between 1 and 50. The default is 10." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the streams in the given compartment id.\nIf the compartment id is specified, it will list streams in the compartment, regardless of their stream pool.\nIf the stream pool id is specified, the action will be scoped to that stream pool.\nThe compartment id and stream pool id cannot be specified at the same time.\n" }, { "info": { "name": "Creates a stream.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts the provisioning of a new stream.\nThe stream will be created in the given compartment id or stream pool id, depending on which parameter is specified.\nCompartment id and stream pool id cannot be specified at the same time.\nTo track the progress of the provisioning, you can periodically call [GetStream](#/en/streaming/20180418/Stream/GetStream).\nIn the response, the `lifecycleState` parameter of the [Stream](#/en/streaming/20180418/Stream/) object tells you its current state.\n" }, { "info": { "name": "Gets a stream", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ] }, "docs": "Gets detailed information about a stream, including the number of partitions." }, { "info": { "name": "Updates a stream.", "type": "http" }, "http": { "method": "PUT", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the stream. Only specified values will be updated.\n" }, { "info": { "name": "Deletes a stream.", "type": "http" }, "http": { "method": "DELETE", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ] }, "docs": "Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations.\nTo verify that a stream has been deleted, make a [GetStream](#/en/streaming/20180418/Stream/GetStream) request. If the call returns the stream's\nlifecycle state as `DELETED`, then the stream has been delete" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment.\nWhen provided, If-Match is checked against ETag values of the resource.\nThe stream will also be moved into the default stream pool in the destination compartment.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. The value must be between 1 and 50. The default is 10." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. The value must be between 1 and 50. The default is 10." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the errors for a work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. The value must be between 1 and 50. The default is 10." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the logs for a work request.\n" } ] } ], "bundled": true }