ListNotebookSessions
GET {{baseUrl}}/notebookSessions?compartmentId={{compartment_ocid}}&id=cillum consectetur labore dolor&projectId=cillum consectetur labore dolor&displayName=cillum consectetur labore dolor&lifecycleState=FAILED&createdBy=cillum consectetur labore dolor&limit=10&sortOrder=ASC&sortBy=timeCreated
Lists the notebook sessions in the specified compartment.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentId | string | (Required) <b>Filter</b> results by the OCID of the compartment. | |
id | string | <b>Filter</b> results by OCID. Must be an OCID of the correct type for the resource type. | |
projectId | string | <b>Filter</b> results by the OCID of the project. | |
displayName | string | <b>Filter</b> results by its user-friendly name. | |
lifecycleState | string | <b>Filter</b> results by the specified lifecycle state. Must be a valid | |
state for the resource type. | |||
createdBy | string | <b>Filter</b> results by the OCID of the user who created the resource. | |
limit | number | For list pagination. The maximum number of results per page, | |
or items to return in a paginated "List" call. | |||
1 is the minimum, 1000 is the maximum. | |||
See List Pagination. |
Example: 500
|
| page
| string | | For list pagination. The value of the opc-next-page
response
header from the previous "List" call.
See List Pagination.
|
| sortOrder
| string | | Specifies sort order to use, either ASC
(ascending) or DESC
(descending).
|
| sortBy
| string | | Specifies the field to sort by. Accepts only one field.
By default, when you sort by timeCreated
, the results are shown
in descending order. When you sort by displayName
, results are
shown in ascending order. Sort order for the displayName
field is case sensitive.
|
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID. | |
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"id":"reprehenderit non occaec","timeCreated":"1995-09-02T03:17:52.339Z","displayName":"pariatur ullamco","projectId":"Ut dolore nulla sint","createdBy":"dolore nisi consecte","compartmentId":"Lorem incididunt","lifecycleState":"CREATING","definedTags":{},"freeformTags":{},"notebookSessionConfigurationDetails":{"shape":"VM.Standard.E3.Flex","subnetId":"nisi ea","blockStorageSizeInGBs":1024,"notebookSessionShapeConfigDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"notebookSessionUrl":"non do"},{"id":"ullamco aliquip esse","timeCreated":"1973-06-29T05:31:28.672Z","displayName":"nisi sed id incididunt","projectId":"magna labore","createdBy":"qui cillum sed culpa labore","compartmentId":"aliqua esse","lifecycleState":"CREATING","definedTags":{},"freeformTags":{},"notebookSessionConfigurationDetails":{"shape":"VM.Standard.E3.Flex","subnetId":"Excepteur","blockStorageSizeInGBs":1024,"notebookSessionShapeConfigDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"notebookSessionUrl":"labore Duis"}]