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.

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:

Show:
graphql
query {
  nonDefaultBucketConfigs {
     id, name, prefix, 
     region, bucket}
}

Returned Datatypes

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

Table: OrgConfig

ParameterTypeRequiredDefaultStabilityDescription
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 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.