PUT /dbaas-thanos/{name}

Update a DBaaS Thanos service

Path parameters

  • name string Required

    Minimum length is 0, maximum length is 63.

application/json

Body Required

  • maintenance object

    Automatic maintenance settings

    Hide maintenance attributes Show maintenance attributes object
    • dow string Required

      Day of week for installing updates

      Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

    • time string Required

      Time for installing updates, UTC

      Minimum length is 8, maximum length is 8.

  • plan string

    Subscription plan

    Minimum length is 1, maximum length is 128.

  • termination-protection boolean

    Service is protected against termination and powering off

  • ip-filter array[string]

    Allowed CIDR address blocks for incoming connections

  • thanos-settings object
    Hide thanos-settings attributes Show thanos-settings attributes object
    • compactor object

      Configuration options for Thanos Compactor.

      Hide compactor attribute Show compactor attribute object
      • retention.days integer

        Retention time for data in days for each resolution (5m, 1h, raw)

        Minimum value is 0.

    • query object

      Configuration options for Thanos Query.

      Hide query attributes Show query attributes object
      • query.default-evaluation-interval string

        Set the default evaluation interval for subqueries.

        Maximum length is 20. Default value is 1m.

      • query.lookback-delta string

        The maximum lookback duration for retrieving metrics during expression evaluations in PromQL. PromQL always evaluates the query for a certain timestamp, and it looks back for the given amount of time to get the latest sample. If it exceeds the maximum lookback delta, it assumes the series is stale and returns none (a gap). The lookback delta should be set to at least 2 times the slowest scrape interval. If unset, it will use the promql default of 5m.

        Maximum length is 20. Default value is 5m.

      • query.metadata.default-time-range string

        The default metadata time range duration for retrieving labels through Labels and Series API when the range parameters are not specified. The zero value means the range covers the time since the beginning.

        Maximum length is 20. Default value is 0s.

      • query.timeout string

        Maximum time to process a query by the query node.

        Maximum length is 20. Default value is 2m.

      • store.limits.request-samples integer

        The maximum samples allowed for a single Series request. The Series call fails if this limit is exceeded. Set to 0 for no limit. NOTE: For efficiency, the limit is internally implemented as 'chunks limit' considering each chunk contains a maximum of 120 samples. The default value is 100 * store.limits.request-series.

        Minimum value is 0, maximum value is 100000000. Default value is 0.

      • store.limits.request-series integer

        The maximum series allowed for a single Series request. The Series call fails if this limit is exceeded. Set to 0 for no limit. The default value is 1000 * cpu_count.

        Minimum value is 0, maximum value is 100000000. Default value is 0.

    • query-frontend object

      Configuration options for Thanos Query Frontend.

      Hide query-frontend attribute Show query-frontend attribute object
      • query-range.align-range-with-step boolean

        Whether to align the query range boundaries with the step. If enabled, the query range boundaries will be aligned to the step, providing more accurate results for queries with high-resolution data.

        Default value is true.

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • reference object

      Related resource reference

      Hide reference attributes Show reference attributes object
      • id string(uuid)

        Reference ID

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.

PUT /dbaas-thanos/{name}
curl \
 --request PUT 'https://api-ch-gva-2.exoscale.com/v2/dbaas-thanos/{name}' \
 --header "Content-Type: application/json" \
 --data '{"maintenance":{"dow":"saturday","time":"string"},"plan":"string","termination-protection":true,"ip-filter":["string"],"thanos-settings":{"compactor":{"retention.days":42},"query":{"query.default-evaluation-interval":"1m","query.lookback-delta":"5m","query.metadata.default-time-range":"0s","query.timeout":"2m","store.limits.request-samples":0,"store.limits.request-series":0},"query-frontend":{"query-range.align-range-with-step":true}}}'
Request examples
{
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "plan": "string",
  "termination-protection": true,
  "ip-filter": [
    "string"
  ],
  "thanos-settings": {
    "compactor": {
      "retention.days": 42
    },
    "query": {
      "query.default-evaluation-interval": "1m",
      "query.lookback-delta": "5m",
      "query.metadata.default-time-range": "0s",
      "query.timeout": "2m",
      "store.limits.request-samples": 0,
      "store.limits.request-series": 0
    },
    "query-frontend": {
      "query-range.align-range-with-step": true
    }
  }
}
Response examples (200)
{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}