openapi: 3.0.1
info:
x-logo:
url: https://www.gridgain.com/assets/web/images/gridgain-logo-2021.svg
backgroundColor: '#FFFFFF'
altText: Example logo
title: GridGain REST module authentication dataNodes API
contact:
email: user@ignite.apache.org
license:
name: Apache 2.0
url: https://ignite.apache.org
version: 9.1.22
servers:
- url: http://localhost:10300
description: Default GridGain 9 management API
- url: http://localhost:8080/ignite
description: GridGain 8 / Ignite REST API
security:
- bearerToken: []
- basicAuth: []
tags:
- name: dataNodes
paths:
/management/v1/zones/datanodes/reset:
post:
tags:
- dataNodes
description: Recalculates and resets data nodes for given zones.
operationId: resetDataNodesForZones
requestBody:
content:
application/json:
schema:
type: array
description: Names specifying zones to recalculate data nodes for. Case-sensitive, if empty then all zones' data nodes will be recalculated.
nullable: true
items:
type: string
responses:
'200':
description: Data nodes are recalculated and reset.
'400':
description: Bad request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/management/v1/zones/{zoneName}/datanodes:
get:
tags:
- dataNodes
description: Returns current data nodes for zone.
operationId: getDataNodesForZone
parameters:
- name: zoneName
in: path
required: true
schema:
type: string
description: Case-sensitive zone name to return data nodes for.
responses:
'200':
description: Data nodes are returned.
content:
application/json:
schema:
uniqueItems: true
type: array
items:
type: string
application/problem+json:
schema:
uniqueItems: true
type: array
items:
type: string
'400':
description: Bad request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/management/v1/zones/{zoneName}/datanodes/reset:
post:
tags:
- dataNodes
description: Recalculates and resets data nodes for zone.
operationId: resetDataNodesForZone
parameters:
- name: zoneName
in: path
required: true
schema:
type: string
description: Case-sensitive zone name to recalculate data nodes for.
responses:
'200':
description: Data nodes are recalculated and reset.
'400':
description: Bad request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal error.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
components:
schemas:
Problem:
type: object
properties:
title:
type: string
description: Short summary of the issue.
status:
type: integer
description: Returned HTTP status code.
format: int32
code:
type: string
description: Ignite 3 error code.
type:
type: string
description: URI to documentation regarding the issue.
detail:
type: string
description: Extended explanation of the issue.
node:
type: string
description: Name of the node the issue happened on.
traceId:
type: string
description: Unique issue identifier. This identifier can be used to find logs related to the issue.
format: uuid
invalidParams:
type: array
description: A list of parameters that did not pass validation and the reason for it.
items:
$ref: '#/components/schemas/InvalidParam'
description: Extended description of the problem with the request.
InvalidParam:
type: object
properties:
name:
type: string
description: Parameter name.
reason:
type: string
description: The issue with the parameter.
description: Information about invalid request parameter.
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerToken:
type: http
scheme: bearer