checkRemoteClusterConnection()

API Stability	`Short-Term`

The checkRemoteClusterConnection() GraphQL query is used to validate a remote cluster connection.

Syntax

Below is the syntax for the checkRemoteClusterConnection() query field:

graphql

checkRemoteClusterConnection(
      input: CheckRemoteClusterConnectionInput!
    ): RemoteClusterConnectionStatus!

For CheckRemoteClusterConnectionInput represents a few required parameters, which are described in the next section. The return datatype, RemoteClusterConnectionStatus is described in the subsequent section. Below is an example of how this query can be used:

Show:

graphql

query {
	checkRemoteClusterConnection(
    input:{publicUrl:"https://logger.company.com",
      token: "7lEkz4aL1dByiwNI1kWuusyBFQQtv086"
    }) 
  {id, remoteViewName, isValid}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	checkRemoteClusterConnection(
    input:{publicUrl:\"https://logger.company.com\",
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\"
    }) 
  {id, remoteViewName, isValid}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	checkRemoteClusterConnection(
    input:{publicUrl:\"https://logger.company.com\",
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\"
    }) 
  {id, remoteViewName, isValid}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
	checkRemoteClusterConnection( ^
    input:{publicUrl:\"https://logger.company.com\", ^
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\" ^
    })  ^
  {id, remoteViewName, isValid} ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	checkRemoteClusterConnection(
    input:{publicUrl:\"https://logger.company.com\",
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\"
    }) 
  {id, remoteViewName, isValid}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
	checkRemoteClusterConnection(
    input:{publicUrl:\"https://logger.company.com\",
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\"
    }) 
  {id, remoteViewName, isValid}
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
	checkRemoteClusterConnection(
    input:{publicUrl:\"https://logger.company.com\",
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\"
    }) 
  {id, remoteViewName, isValid}
}"
}'''

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

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
	checkRemoteClusterConnection(
    input:{publicUrl:\"https://logger.company.com\",
      token: \"7lEkz4aL1dByiwNI1kWuusyBFQQtv086\"
    }) 
  {id, remoteViewName, isValid}
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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

Show:

json

{
  "data": {
    "checkRemoteClusterConnection": {
      "id": null,
      "remoteViewName": "humio",
      "isValid": true
    }
  }
}

For the input's special datatype, the values are given within curly-brackets. As for the returned results, a list of requests is entered in a comma-separated list, also within curly-brackets. Further down this page is a list of what's allowed.

Given Datatypes

For CheckRemoteClusterConnectionInput, there are a few parameters. Below is a list of them along with descriptions of each:

Table: CheckRemoteClusterConnectionInput

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
`connectionId`	string		`Short-Term`	The unique identifier of the connection to check. Must be supplied if the token is not supplied.
`multiClusterViewName`	string		`Short-Term`	The name of the multi-cluster view to which the connection belongs. Must be supplied if the token is not supplied.
`publicUrl`	string	yes	`Short-Term`	The public URL of the remote cluster to connect.
`queryPrefix`	string		`Short-Term`	Filter query that restricts the data visible through this connection.
`tags`	[`ClusterConnectionInputTag`]	yes	`Short-Term`	Additional tags that can be used to filter queries. See `ClusterConnectionInputTag`.
`token`	string	yes	`Short-Term`	The access token for the remote view to connect with. Can be omitted if checking an existing connection with no token change.

Returned Datatypes

For RemoteClusterConnectionStatus, there are several possible values returned, which are listed below:

Table: RemoteClusterConnectionStatus

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2024
`errorMessages`	[`ConnectionAspectErrorType`]	yes	`Short-Term`	Errors if the connection is invalid. See `ConnectionAspectErrorType`.
`id`	string		`Short-Term`	The unique identifier of the connection.
`isValid`	boolean	yes	`Short-Term`	Whether the connection is valid.
`remoteServerCompatVersion`	string		`Short-Term`	Oldest server version that is protocol compatible with the remote server.
`remoteServerVersion`	string		`Short-Term`	Software version of the remote view.
`remoteViewName`	string		`Short-Term`	The name of the remote view.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes