Status (Workspace)

URL:
https://<root>/notebooks/workspaces/<workspaceId>/status
Methods:
GET
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
11.4

Description

The status resource returns the status of the notebook workspace. When the status is pending, ensure that the PV used for registering the workspace exists and can be bound. Details on a failure to bind a PV will be returned as part of eventLogs property in the notebook workspace status response. Attempting to enable the Notebook Services capability when the workspace status is pending will result in a failure.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the status resource:

1
https://organization.domain.com/context/admin/notebooks/workspaces/utz5kgaz4vd6dpj3xrsyb/status?f=json

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "name": "arcgis-notebooks-workspace",
    "id": "utz5kgaz4vd6dpj3xrsyb",
    "type": "PVC",
    "spec": {
        "storageClassName": "arcgis-storage-default",
        "volumeName": "",
        "resources": {
            "requests": {"storage": "100Gi"},
            "limits": {}
        },
        "accessModes": ["ReadWriteMany"],
        "volumeMode": "Filesystem"
    },
    "managedKubernetesResources": [{
        "purpose": "pvc",
        "kind": "PersistentVolumeClaim",
        "name": "arcgis-nb-workspace-volume-utz5kgaz4vd6dpj3xrsyb"
    }],
    "revision": 1,
    "info": {
        "volumeIdentifier": "",
        "volumePath": "/arcgis/home"
    },
    "status": "Bound"
}

JSON Response example 2

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
    "eventLogs": "Kubernetes Resource PersistentVolumeClaim/arcgis-nb-workspace-volume-uiqfeuaqq3fyt7cdiszuf reported event; count: 2, reason: FailedBinding, message: volume \"notebooksworkspace-pv-ar-123456789\" already bound to a different claim.. ",
    "name": "arcgis-notebooks-workspace",
    "id": "uiqfeuaqq3fyt7cdiszuf",
    "type": "PVC",
    "spec": {
        "storageClassName": "",
        "volumeName": "notebooksworkspace-pv-ar-123456789",
        "resources": {
            "requests": {"storage": "135Gi"},
            "limits": {}
        },
        "accessModes": ["ReadWriteMany"],
        "volumeMode": "Filesystem"
    },
    "managedKubernetesResources": [{
        "purpose": "pvc",
        "kind": "PersistentVolumeClaim",
        "name": "arcgis-nb-workspace-volume-uiqfeuaqq3fyt7cdiszuf"
    }],
    "revision": 1,
    "info": {
        "volumeIdentifier": "",
        "volumePath": "/arcgis/home"
    },
    "status": "Pending"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close