Container

• URL: https://<notebookserveradmin>/system/containers/<containerId>
  
• Required Capability:Administrator or Create and Edit ArcGIS Notebooks
• Related Resources:System, Containers, Container Sessions, Container Statistics, Terminate Container
• Version Introduced:10.7

Description

This resource returns information about a single container. This is available to the owner of the container or an administrator.

Request parameters

Parameter	Details
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

https://notebookserver.domain.com:port/arcgis/admin/system/containers/<containerId>?f=json

JSON Response syntax

{
  "hostName": "<hostname>",
  "memory": <memory in mb>,
  "imageName": "<image name>",
  "hostIp": "<hostIp>",
  "cpus": <cpu share>,
  "httpPort": <http port>,
  "containerUrl": "<container Url>",
  "httpsPort": <https port>,
  "dateCreated": "<date created in UTC Epoch time>",
  "id": "<id>",
  "containerId": "<containerId>",
  "username": "<container owner username>",
  "type": "openNotebook|executeNotebook",
  "notebookRuntimeId": "<Id of the notebook runtime used by the container>",
  "notebookRuntimeVersion": "Version of the notebook runtime used by the container",
  "notebookRuntimeName": "<Name of the notebook runtime used by the container>",
  "containerHostname": "<Hostname of the container>",
}

JSON Response example

JSON Response example one

{
  "hostName": "hostname.domain.com",
  "memory": 0,
  "imageName": "f4b0def4458c1160e7f4c835bb91464c94413bcb6aaa16fb64b4e971a33656d6",
  "hostIp": "177.31.28.8",
  "cpus": 0,
  "httpPort": 30001,
  "containerUrl": "/notebooks/031d2bff0b354a5ebc191f37a78191af",
  "type": "openNotebook",
  "httpsPort": 30001,
  "notebookRuntimeVersion": "5.0",
  "notebookRuntimeName": "ArcGIS Notebook Python 3 Advanced",
  "dateCreated": 1609918113958,
  "containerHostname": "ba86bb2168a1",
  "id": "031d2bff0b354a5ebc191f37a78191af",
  "notebookRuntimeId": "1725316f-eabf-4935-9910-103de584a0cc",
  "containerId": "778bf9a898158f36ae1bd7a01e0b18078bf783a624fa6b40522c038285301bd3",
  "username": "jdoe007"
}

JSON Response example two

{
  "hostName": "hostname.domain.com",
  "memory": 4,
  "imageName": "4e38f29a58a66f852ecf2d9484a9794e0d1ae9481120d1b390aff105d607be0b",
  "hostIp": "177.31.28.8",
  "cpus": 1,
  "httpPort": -1,
  "containerUrl": "",
  "type": "executeNotebook",
  "httpsPort": -1,
  "notebookRuntimeVersion": "5.0",
  "notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
  "dateCreated": 1609919697613,
  "containerHostname": "6bb4b7de2fbd",
  "id": "f2274e5fe7ad42e39cb5f0313a22bdab",
  "notebookRuntimeId": "9d23fa3b-33f8-46ce-9299-13a06696c95d",
  "containerId": "145edf64da271274d55601b13215846dd3783696e35c36dcd6977a040eafe27c",
  "username": "jdoe007"
}