Lists the streams in the given compartment id.
GET {{baseUrl}}/streams?compartmentId={{compartment_ocid}}&limit=10&sortBy=TIMECREATED&sortOrder=ASC
Lists the streams in the given compartment id. If the compartment id is specified, it will list streams in the compartment, regardless of their stream pool. If the stream pool id is specified, the action will be scoped to that stream pool. The compartment id and stream pool id cannot be specified at the same time.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentId | string | The OCID of the compartment. Is exclusive with the streamPoolId parameter. One of them is required. | |
streamPoolId | string | The OCID of the stream pool. Is exclusive with the compartmentId parameter. One of them is required. | |
id | string | A filter to return only resources that match the given ID exactly. | |
name | string | A filter to return only resources that match the given name exactly. | |
limit | number | The maximum number of items to return. The value must be between 1 and 50. The default is 10. | |
page | string | The page at which to start retrieving results. | |
sortBy | string | 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. | |
sortOrder | string | The sort order to use, either 'asc' or 'desc'. | |
lifecycleState | string | A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. | |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a | |
particular request, please provide the request ID. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"compartmentId":"ocid1.compinstance.realm.region.zxcvbn432765","id":"ocid1.stream.realm.region.mnopqr789","lifecycleState":"ACTIVE","messagesEndpoint":"commodo ea officia","name":"TelemetryEvents","partitions":10,"streamPoolId":"ocid1.streampool.realm.region.zxcvbn432765","timeCreated":"1996-03-07T10:22:20.217Z","definedTags":{},"freeformTags":{}},{"compartmentId":"ocid1.compinstance.realm.region.zxcvbn432765","id":"ocid1.stream.realm.region.mnopqr789","lifecycleState":"UPDATING","messagesEndpoint":"ut Duis","name":"TelemetryEvents","partitions":10,"streamPoolId":"ocid1.streampool.realm.region.zxcvbn432765","timeCreated":"1979-11-09T11:06:40.561Z","definedTags":{},"freeformTags":{}}]