Retrieve info about nodes

GET /snaplex/{env_org}?{query_parameters}

Overview

This API retrieves Snaplex and JCC wrapper information about all nodes or about a specific node.
  • If only plex_path is specified, it retrieves information about all the nodes in the Snaplex.
  • If both plex_path and hostname are specified, it retrieves information about that specific node.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 GET https://{controlplane_path}/api/1/rest/public/snaplex/{env_org}?{query_parameters}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
org Required. The name of the SnapLogic Environment/Org.

Query Parameters

Key Type Description
plex_path string The path to the Snaplex. The path comparison is case-sensitive.

Format: /{env_org}/{project_space}/{project_name}/{snaplex_name}

Default: All Snaplexes.

hostname string A single JCC node path or a comma-separated list of JCC node paths.

Default: All JCC nodes.

Example: canxl-jcc8.clouddev.snaplogic.com,canxl-jcc9.clouddev.snaplogic.com

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

None.

Response

Response Body

The response map contains a section for each Snaplex. Each Snaplex section includes:
  • plex_info. Metadata related to the specified Snaplex.
  • cc_info. Information about the JCCs running on the specified Snaplex.
 {
  "response_map": {
    "/myEnvOrg/path/to/snaplex": {
      "plex_info": { ... },
      "cc_info": { ... }
    }
  },
  "http_status_code": 200
}

plex_info

 "plex_info": {

  "org": "/myEnvOrg",
  "location": "myLocation",
  "environment": "myEnv",
  "min_jcc": 1,
  "container_type": "regular",
  "class_version": 3,
  "class_id": "com-snaplogic-snaplex",
  "class_fqid": "com-snaplogic-snaplex_3",
  "pkg_version": "4.34_rc-19616",
  "notification": {
      "recipients": ""
  },
  "disabled_notification": null,
  "reserved_slots": 15,
  "max_slots": 2000,
  "max_mem": 85,
  "jcc_load_balancer": "",
  "feed_master_load_balancer": "",
  "node_settings": {
      "published": {
          "heap": {
              "max_size": "auto"
          },
          "jetty_host": "0.0.0.0",
          "jetty_port": 8090,
          "cc_secure_port": null,
          "http": {
              "proxyHost": "",
              "proxyPort": null
          },
          "https": {
              "proxyHost": "",
              "proxyPort": null
          },
          "nodes": [ ... ]
      },
      "extra": [ ... ]
  },
  "node_settings_fp": "...",
  "dynamic_settings": {
      "log": {
          "level": "debug",
          "max_file_size": "300 MB",
          "main_backup_count": 40,
          "error_backup_count": 5,
          "access_backup_count": 5
      }
  },
  "restart_max_waiting_time": 15,
  "instance_id": "...",
  "load_avg_duration": 1,
  "plexfs_min_free": 25,
  "plexfs_retention_time": 14,
  "restart_request_time": "",
  "restart_request_user": "",
  "queue_size": 50,
  "label": "myPlexLabel",
  "snode_id": "...",
  "path": "/myEnvOrg/path/to/snaplex",
  "runtime_path_id": "myEnvOrg/rt/cloud/myEnv",
  "perms": [
      "A",
      "X",
      "W",
      "R"
  ],
  "owner": "[email protected]",
  "org_snode_id": "...",
  "lease_info": { ... },
  "time_leased": null,
  "time_created": "2023-03-08T20:11:08.346000+00:00",
  "time_updated": "2023-08-03T19:02:23.598000+00:00",
  "jcc_count": 2,
  "fm_count": 2
},
Key Type Description
org string The name of the SnapLogic Environment/Org that the Snaplex belongs to, prefixed with /.
location string The location of the Snaplex.
environment string The environment of the Snaplex.
min_jcc string The minimum number of JCC nodes in the Snaplex.
container_type string The type of container (JCC node).
Possible values:
  • regular
  • mixed
  • null
class_id string The identifier of the Snaplex.
class_fqid string The fully-qualified ID of a Snaplex.

Format: {Snaplex_class_id}_{class_version}

class_version integer
pkg_version string The SnapLogic package version that is installed in the Snaplex.
notification » recipients string A comma-separated list of email addresses to send notifications to.
disabled_notification string
reserved_slots string
max_slots string
max_mem string
feed_master_load_balancer string The URL to the FeedMaster which serves as the load balancer.
jcc_load_balancer string The URL to the JCC node which serves as the load balancer.
node_settings » published object
  • heap » max_size (string)
  • jetty_host (string)
  • jetty_port (integer)
  • cc_secure_port (string)
  • nodes (array)
  • http/https » proxyHost (string)
  • http/https » proxyPort (string)
node_settings » extra array
node_settings_fp string
dynamic_settings » log object
  • level (string)
  • max_file_size (string)
  • main_backup_count (integer)
  • error_backup_count (integer)
  • access_backup_count (integer)
restart_max_waiting_time integer
instance_id string
load_avg_duration string
plexfs_min_free string
plexfs_retention_time string
restart_request_time string
restart_request_user string
queue_size string
label string
snode_id string
path string The path to the Snaplex.
runtime_path_id string
perms array An array containing one or more of the following permissions:
  • "R" – read
  • "W" – write
  • "X" – execute
  • "A" – admin

Learn more: Permissions in Manager and in APIs

owner string The email address of the Snaplex owner.
org_snode_id string The ID of the Snaplex node that hosts the Environment/Org of the pipeline.
lease_info object Information about the Snaplex lease, if applicable.
time_leased datetime The date and time the Snaplex was leased, if applicable, in UTC format.
time_created datetime The date and time the Snaplex was created, in UTC format.
time_updated datetime The date and time of the last version update to the Snaplex, in UTC format.
jcc_count integer The number of JCC nodes in the Snaplex.
fm_count integer The number of FeedMasters in the Snaplex.

cc-info

 "cc_info": {
  "running": [ ... ],
  "down": [ ... ],
  "label": "...",
  "runtime_path_id": "...",
  "snode_id": "...",
  "instance_id": "...",
  "path": "...",
  "owner": "[email protected]",
  "container_type": "regular",
  "time_created": "...",
  "time_updated": "...",
  "jcc_count": 0,
  "fm_count": 0,
  "location": "...",
  "max_slots": "...",
  "leader": null,
  "status": "..."
}
Key Type Description
running array All the containers that were running when the API request was made. Each item in the list is a map containing more details about the container (JCC node).
down array All the JCC nodes that were down and not processing requests when the API request was made​. Each item in the list is a map containing more details about the container. For example, a message is returned under alerts if your Snaplex version is deprecated and needs to be updated.
label string
runtime_path_id string
snode_id string
instance_id string
path string
owner string The email address of the JCC node owner.
container_type string The type of container (JCC node).
Possible values:
  • regular
  • mixed
  • null
time_created datetime The date and time the JCC node was created, in UTC format.
time_updated datetime The date and time of the last version update to the JCC node, in UTC format.
jcc_count integer The number of JCC nodes in the Snaplex.
fm_count integer The number of FeedMasters in the Snaplex.
location string The location of the Snaplex.
max_slots string
leader
status string