API Stability Short-Term

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.

There are a few mutation fields related to this query field: setOrganizationBucket1() and setOrganizationBucket2() to set the primary and secondary bucket target for an organization; unsetOrganizationBucket2() to unset the secondary bucket target; and removeOrganizationBucketConfig() to remove the bucket configuration.

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

Syntax

graphql
nonDefaultBucketConfigs: [OrgConfig]!

There isn't an input for this query field, but there are a few returned parameters that may be requested. You can get some basic information about a bucket configuration (e.g., its unique identifier, region used, etc.) See the Returned Datatype section for more.

Example

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 $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}";
$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 {
  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',
  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": {
    "nonDefaultBucketConfigs": {
      "id": "abc123",
      "name": "OutBucket",
      "prefix": "server1_",
      "region": "us-west-2",
      "bucket": "pale-1"
    }
  }
}

Returned Datatype

With the returned datatype, you can get the bucket's unique identifier, region used, any prefix, and other configuration information. Below is a list of what's available:

Table: OrgConfig

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 27, 2024
bucketstringyes Short-TermThe bucket used.
idstringyes Short-TermThe unique identifier of the organization.
namestringyes Short-TermThe name of the organization.
prefixstringyes Short-TermThe prefix of the bucket.
regionstringyes Short-TermThe region of the bucket.