Get service upgrade window | ClickHouse Docs

GET/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow

Returns the configured upgrade window for a service.

Errors:

401: missing, invalid, or disabled API key.
403: caller lacks control-plane:service:view on the service.
404: service does not exist, is not visible to the caller, or no upgrade window has been configured.

Permission

The API key must have the control-plane:service:view permission.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service.

format: uuid

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
3 properties
- weekdayintegerrequired
  Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday.
  
  maximum: 6, minimum: 0
  Example: 3
- startHourUtc0or6or12or18required
  UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18.
  
  Example: 12
- duration6required
  Length of the upgrade window in hours. Currently only a 6-hour window is supported.
  
  Example: 6

Get service upgrade window

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/upgradeWindow \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/upgradeWindow';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/upgradeWindow"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "weekday": 3,
    "startHourUtc": 12,
    "duration": 6
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}