Summary

The checkLocalClusterConnection() GraphQL query is used to validate a local cluster connection — to check that's configured properly and running.

Hide Query Example

Show Cluster Nodes Query

API Stability Short-Term

Syntax

graphql
checkLocalClusterConnection(
      input: CheckLocalClusterConnectionInput!
   ): LocalClusterConnectionStatus

For the input, you'd enter parameters for checking the local cluster connection, such as the unique identifier of the connection to check and the view for it. This is described in the Input Parameters section.

For the results, primarily you'd request whether the connection is valid and maybe if there are any error messages. See the Returned Datatype for more choices.

Example

Raw
graphql
query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: "humio"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: \"humio\"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: \"humio\"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
	checkLocalClusterConnection( ^
	   input: ^
	     {targetViewName: \"humio\"} )  ^
	  { id, ^
	    viewName,  ^
	    isValid,  ^
	    errorMessages{ error } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: \"humio\"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: \"humio\"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: \"humio\"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
	checkLocalClusterConnection(
	   input:
	     {targetViewName: \"humio\"} ) 
	  { id,
	    viewName, 
	    isValid, 
	    errorMessages{ error } }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "checkLocalClusterConnection": {
      "id": null,
      "viewName": "humio",
      "isValid": true,
      "errorMessages": []
    }
  }
}

Input Parameters

For the input, you can enter the unique identifier of the connection and the name of the view associated with it. The parameters required and allowed are listed, along with a description of each:

Table: CheckLocalClusterConnectionInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 17, 2024
connectionIdstring  Short-TermThe unique identifier of the connection to check.
queryPrefixstring  Short-TermFilter query that restricts the data visible through this connection.
tags[ClusterConnectionInputTag]yes Short-TermAdditional tags that can be used to filter queries. See ClusterConnectionInputTag.
targetViewNamestringyes Short-TermThe name or unique identifier of the local view.

Returned Values

For the results, you can get information about the local connection and its status. A key one is whether the connection is valid. The possibile values returned are listed and described below:

Table: LocalClusterConnectionStatus Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 26, 2025
errorMessages[ConnectionAspectErrorType]yes Short-TermErrors if the connection is invalid. See ConnectionAspectErrorType.
idstring  Short-TermThe unique identifier of the connection.
isValidbooleanyes Short-TermWhether the connection is valid.
viewNamestring  Short-TermThe name of the local view.