API Stability Short-Term

The updateIngestPartitionScheme() GraphQL mutation field is used to set the ingest partition scheme of a LogScale cluster. It requires ManageCluster permission. The ingest partition scheme is normally automated; Changes will be overwritten by the automation. This mutation field shouldn't be used generally, unless automation is temporarily disabled.

Syntax

Below is the syntax for the updateIngestPartitionScheme() mutation field:

graphql
updateIngestPartitionScheme(
      partitions: [IngestPartitionInput]!
   ): BooleanResultType!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}
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" : "mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}"
}
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" : "mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}"
}
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" : "mutation { ^
  updateIngestPartitionScheme(  ^
       partitions: { id: 1, nodeIds: [ 1, 2 ] } ^
  ) ^
  { result } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}"
}'
    "$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 = "mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}";
$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" : "mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}"
}'''

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" : "mutation {
  updateIngestPartitionScheme( 
       partitions: { id: 1, nodeIds: [ 1, 2 ] }
  )
  { result }
}"
}
);


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

Given Datatypes

For IngestPartitionInput, there are a couple of parameters. Below is a list of them along with a description of each:

Table: IngestPartitionInput

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 18, 2024
idintegeryes Short-TermThe unique identifier of the ingest partition.
nodeIds[integer]yes Short-TermThe unique identifiers of the node.

Returned Datatypes

The returned datatype BooleanResultType one parameter. It's described below:

Table: BooleanResultType

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.