The nonDefaultBucketConfigs() GraphQL query is used to return a list of organizations that have non-default bucket-storage configuration. The intended use, though, is to help with managing a fleet of LogScale clusters.

For more information, see the Fleet Management (fleetManagement) and Ingestion: Storage Phase documentation pages.

Syntax

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

graphql
nonDefaultBucketConfigs: [OrgConfig!]!

There isn't an input for this query field, but there are a few returned parameters that may be requested (see the Returned Datatype section). Below is an example of how this query field might be used:

Raw
graphql
query {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}
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 {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}"
}
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 {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}"
}
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 { ^
  nonDefaultBucketConfigs { ^
     id, name, prefix,  ^
     region, bucket} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}"
}';
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 {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}"
}'''

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 {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}"
}
);


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();

Returned Datatypes

OrgConfig has a few parameters. Below is a list of them along with a description of each:

Table: OrgConfig

ParameterTypeRequiredDefaultDescription
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 27, 2024
bucketstringyes The bucket used.
idstringyes The unique identifier of the organization.
namestringyes The name of the organization.
prefixstringyes The prefix of the bucket.
regionstringyes The region of the bucket.