Instaclustr Logo
Powered by Redocly

Cluster Exclusion Window V2

Cluster exclusion window

List cluster exclusion windows

Lists all exclusion windows (times when maintenance events cannot be performed) for the cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster

Responses
200

Successfully retrieved exclusion windows for cluster

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format

get/cluster-management/v2/data-sources/cluster/{clusterId}/exclusion-windows/v2
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create cluster exclusion window
Creates a new exclusion window (time when maintenance events cannot be performed) for the cluster


SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
Details of the cluster exclusion window


dayOfWeek
required
string
The day of the week that this exclusion window starts on


 Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"  
startHour
required
integer <int32>   [ 0 .. 23 ] 
The hour of the day that this exclusion window starts on


 
durationInHours
required
integer <int32>   >= 1 
The duration (in hours) of this exclusion window


 
clusterId
required
string <uuid> 
Cluster Id for the cluster that this exclusion window relates to


 
Responses 
202
Successfully created exclusion window


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format


post/cluster-management/v2/resources/exclusion-windows/v2
Request samples 
application/json
{
  • "clusterId": "cf4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "dayOfWeek": "TUESDAY",
  • "durationInHours": 6,
  • "id": "af4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "startHour": 14
}
Response samples 
application/json
{
  • "clusterId": "cf4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "dayOfWeek": "TUESDAY",
  • "durationInHours": 6,
  • "id": "af4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "startHour": 14
}
Get cluster exclusion window details
SecurityBasic Authentication 
Request 
path Parameters
windowId
required
string <uuid> 
ID of the Exclusion window


 
Responses 
200
Retrieve the details of the cluster exclusion window


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format


get/cluster-management/v2/resources/exclusion-windows/v2/{windowId}
Request samples 
Response samples 
application/json
{
  • "clusterId": "cf4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "dayOfWeek": "TUESDAY",
  • "durationInHours": 6,
  • "id": "af4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "startHour": 14
}
Delete cluster exclusion window
Removes an exclusion window for the cluster


SecurityBasic Authentication 
Request 
path Parameters
windowId
required
string <uuid> 
ID of the Exclusion window


 
Responses 
204
Successfully deleted exclusion window


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format


429
Too many requests: returned when more than 35 requests per second are being received by your user


delete/cluster-management/v2/resources/exclusion-windows/v2/{windowId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Cluster Maintenance Events V2