Managed Service for YDB API, REST: Database.Get

Written by

Updated at October 17, 2024

HTTP request
Path parameters
Response
StorageConfig
StorageOption
ScalePolicy
FixedScale
ZonalDatabase
RegionalDatabase
DedicatedDatabase
ServerlessDatabase
BackupConfig
BackupSettings
BackupSchedule
DailyBackupSchedule
TimeOfDay
WeeklyBackupSchedule
DaysOfWeekBackupSchedule
RecurringBackupSchedule
MonitoringConfig
Alert
NotificationChannel
AlertParameter
DoubleParameterValue
IntegerParameterValue
TextParameterValue
TextListParameterValue
LabelListParameterValue

Returns the specified database.

HTTP request

GET https://ydb.api.cloud.yandex.net/ydb/v1/databases/{databaseId}

Path parameters

Field

Description

databaseId

string

Required field. Required. ID of the YDB cluster.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "endpoint": "string",
  "resourcePresetId": "string",
  "storageConfig": {
    "storageOptions": [
      {
        "storageTypeId": "string",
        "groupCount": "string"
      }
    ],
    "storageSizeLimit": "string"
  },
  "scalePolicy": {
    // Includes only one of the fields `fixedScale`
    "fixedScale": {
      "size": "string"
    }
    // end of the list of possible fields
  },
  "networkId": "string",
  "subnetIds": [
    "string"
  ],
  // Includes only one of the fields `zonalDatabase`, `regionalDatabase`, `dedicatedDatabase`, `serverlessDatabase`
  "zonalDatabase": {
    "zoneId": "string"
  },
  "regionalDatabase": {
    "regionId": "string"
  },
  "dedicatedDatabase": {
    "resourcePresetId": "string",
    "storageConfig": {
      "storageOptions": [
        {
          "storageTypeId": "string",
          "groupCount": "string"
        }
      ],
      "storageSizeLimit": "string"
    },
    "scalePolicy": {
      // Includes only one of the fields `fixedScale`
      "fixedScale": {
        "size": "string"
      }
      // end of the list of possible fields
    },
    "networkId": "string",
    "subnetIds": [
      "string"
    ],
    "assignPublicIps": "boolean"
  },
  "serverlessDatabase": {
    "throttlingRcuLimit": "string",
    "storageSizeLimit": "string",
    "enableThrottlingRcuLimit": "boolean",
    "provisionedRcuLimit": "string",
    "topicWriteQuota": "string"
  },
  // end of the list of possible fields
  "assignPublicIps": "boolean",
  "locationId": "string",
  "labels": "string",
  "backupConfig": {
    "backupSettings": [
      {
        "name": "string",
        "description": "string",
        "backupSchedule": {
          // Includes only one of the fields `dailyBackupSchedule`, `weeklyBackupSchedule`, `recurringBackupSchedule`
          "dailyBackupSchedule": {
            "executeTime": {
              "hours": "integer",
              "minutes": "integer",
              "seconds": "integer",
              "nanos": "integer"
            }
          },
          "weeklyBackupSchedule": {
            "daysOfWeek": [
              {
                "days": [
                  "string"
                ],
                "executeTime": {
                  "hours": "integer",
                  "minutes": "integer",
                  "seconds": "integer",
                  "nanos": "integer"
                }
              }
            ]
          },
          "recurringBackupSchedule": {
            "startTime": "string",
            "recurrence": "string"
          },
          // end of the list of possible fields
          "nextExecuteTime": "string"
        },
        "backupTimeToLive": "string",
        "sourcePaths": [
          "string"
        ],
        "sourcePathsToExclude": [
          "string"
        ],
        "type": "string",
        "storageClass": "string"
      }
    ]
  },
  "documentApiEndpoint": "string",
  "kinesisApiEndpoint": "string",
  "kafkaApiEndpoint": "string",
  "monitoringConfig": {
    "alerts": [
      {
        "alertId": "string",
        "alertTemplateId": "string",
        "name": "string",
        "description": "string",
        "notificationChannels": [
          {
            "notificationChannelId": "string",
            "notifyAboutStatuses": [
              "string"
            ],
            "repeateNotifyDelayMs": "string"
          }
        ],
        "alertParameters": [
          {
            // Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`
            "doubleParameterValue": {
              "name": "string",
              "value": "string"
            },
            "integerParameterValue": {
              "name": "string",
              "value": "string"
            },
            "textParameterValue": {
              "name": "string",
              "value": "string"
            },
            "textListParameterValue": {
              "name": "string",
              "values": [
                "string"
              ]
            },
            "labelListParameterValue": {
              "name": "string",
              "values": [
                "string"
              ]
            }
            // end of the list of possible fields
          }
        ],
        "alertThresholds": [
          {
            // Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`
            "doubleParameterValue": {
              "name": "string",
              "value": "string"
            },
            "integerParameterValue": {
              "name": "string",
              "value": "string"
            },
            "textParameterValue": {
              "name": "string",
              "value": "string"
            },
            "textListParameterValue": {
              "name": "string",
              "values": [
                "string"
              ]
            },
            "labelListParameterValue": {
              "name": "string",
              "values": [
                "string"
              ]
            }
            // end of the list of possible fields
          }
        ]
      }
    ]
  },
  "deletionProtection": "boolean"
}

YDB database.

Field	Description
id	string
folderId	string
createdAt	string (date-time) String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string
description	string
status	enum (Status) `STATUS_UNSPECIFIED` `PROVISIONING` `RUNNING` `UPDATING` `ERROR` `DELETING` `STARTING` `STOPPED`
endpoint	string
resourcePresetId	string
storageConfig	StorageConfig
scalePolicy	ScalePolicy
networkId	string
subnetIds[]	string
zonalDatabase	ZonalDatabase deprecated field Includes only one of the fields `zonalDatabase`, `regionalDatabase`, `dedicatedDatabase`, `serverlessDatabase`.
regionalDatabase	RegionalDatabase deprecated field Includes only one of the fields `zonalDatabase`, `regionalDatabase`, `dedicatedDatabase`, `serverlessDatabase`.
dedicatedDatabase	DedicatedDatabase Includes only one of the fields `zonalDatabase`, `regionalDatabase`, `dedicatedDatabase`, `serverlessDatabase`.
serverlessDatabase	ServerlessDatabase Includes only one of the fields `zonalDatabase`, `regionalDatabase`, `dedicatedDatabase`, `serverlessDatabase`.
assignPublicIps	boolean
locationId	string
labels	string
backupConfig	BackupConfig
documentApiEndpoint	string
kinesisApiEndpoint	string
kafkaApiEndpoint	string
monitoringConfig	MonitoringConfig
deletionProtection	boolean

StorageConfig

Field

Description

storageOptions[]

StorageOption

storageSizeLimit

string (int64)

output only field: storage size limit of dedicated database.

StorageOption

Field	Description
storageTypeId	string
groupCount	string (int64)

ScalePolicy

Field

Description

fixedScale

FixedScale

Includes only one of the fields fixedScale.

FixedScale

Field	Description
size	string (int64)

ZonalDatabase

Field

Description

zoneId

string

Required field.

RegionalDatabase

Field

Description

regionId

string

Required field.

DedicatedDatabase

Field	Description
resourcePresetId	string
storageConfig	StorageConfig
scalePolicy	ScalePolicy
networkId	string
subnetIds[]	string
assignPublicIps	boolean

ServerlessDatabase

Field	Description
throttlingRcuLimit	string (int64) Let's define 1 RU - 1 request unit Let's define 1 RCU - 1 request capacity unit, which is 1 RU per second. If `enable_throttling_rcu_limit` flag is true, the database will be throttled using `throttling_rcu_limit` value. Otherwise, the database is throttled using the cloud quotas. If zero, all requests will be blocked until non zero value is set.
storageSizeLimit	string (int64) Specify serverless database storage size limit. If zero, default value is applied.
enableThrottlingRcuLimit	boolean If false, the database is throttled by cloud value.
provisionedRcuLimit	string (int64) Specify the number of provisioned RCUs to pay less if the database has predictable load. You will be charged for the provisioned capacity regularly even if this capacity is not fully consumed. You will be charged for the on-demand consumption only if provisioned capacity is consumed.
topicWriteQuota	string (int64) write quota for topic service, defined in bytes per second.

BackupConfig

Field	Description
backupSettings[]	BackupSettings

BackupSettings

Field	Description
name	string name of backup settings
description	string human readable description.
backupSchedule	BackupSchedule provide schedule. if empty, backup will be disabled.
backupTimeToLive	string (duration) provide time to live of backup.
sourcePaths[]	string provide a list of source paths. Each path can be directory, table or even database itself. Each directory (or database) will be traversed recursively and all childs of directory will be included to backup. By default, backup will be created for full database.
sourcePathsToExclude[]	string provide a list of paths to exclude from backup. Each path is a directory, table, or database. Each directory (or database) will be traversed recursively and all childs of directory will be excluded.
type	enum (Type) `TYPE_UNSPECIFIED` `SYSTEM` `USER`
storageClass	enum (StorageClass) `STORAGE_CLASS_UNSPECIFIED` `STANDARD` `REDUCED_REDUNDANCY` `STANDARD_IA` `ONEZONE_IA` `INTELLIGENT_TIERING` `GLACIER` `DEEP_ARCHIVE` `OUTPOSTS`

BackupSchedule

Field	Description
dailyBackupSchedule	DailyBackupSchedule Includes only one of the fields `dailyBackupSchedule`, `weeklyBackupSchedule`, `recurringBackupSchedule`.
weeklyBackupSchedule	WeeklyBackupSchedule Includes only one of the fields `dailyBackupSchedule`, `weeklyBackupSchedule`, `recurringBackupSchedule`.
recurringBackupSchedule	RecurringBackupSchedule Includes only one of the fields `dailyBackupSchedule`, `weeklyBackupSchedule`, `recurringBackupSchedule`.
nextExecuteTime	string (date-time) output only field: when next backup will be executed using provided schedule. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

DailyBackupSchedule

Field

Description

executeTime

TimeOfDay

Required field.

Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are google.type.Date and google.protobuf.Timestamp.

Field	Description
hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

WeeklyBackupSchedule

Field	Description
daysOfWeek[]	DaysOfWeekBackupSchedule

DaysOfWeekBackupSchedule

Field

Description

days[]

enum (DayOfWeek)

DAY_OF_WEEK_UNSPECIFIED: The unspecified day-of-week.
MONDAY: The day-of-week of Monday.
TUESDAY: The day-of-week of Tuesday.
WEDNESDAY: The day-of-week of Wednesday.
THURSDAY: The day-of-week of Thursday.
FRIDAY: The day-of-week of Friday.
SATURDAY: The day-of-week of Saturday.
SUNDAY: The day-of-week of Sunday.

executeTime

TimeOfDay

Required field.

RecurringBackupSchedule

Field

Description

startTime

string (date-time)

Required field. Timestamp of the first recurrence.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

recurrence

string

Required field. An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how
this backup reccurs.
The FREQ values of MINUTELY, and SECONDLY are not supported.

MonitoringConfig

Field	Description
alerts[]	Alert

Alert

Field	Description
alertId	string output only field.
alertTemplateId	string template of the alert.
name	string name of the alert.
description	string human readable description of the alert.
notificationChannels[]	NotificationChannel the notification channels of the alert.
alertParameters[]	AlertParameter alert parameters to override.
alertThresholds[]	AlertParameter alert paratemers to override.

NotificationChannel

Field	Description
notificationChannelId	string
notifyAboutStatuses[]	enum (AlertEvaluationStatus) `ALERT_EVALUATION_STATUS_UNSPECIFIED` `ALERT_EVALUATION_STATUS_OK` `ALERT_EVALUATION_STATUS_NO_DATA` `ALERT_EVALUATION_STATUS_ERROR` `ALERT_EVALUATION_STATUS_ALARM` `ALERT_EVALUATION_STATUS_WARN`
repeateNotifyDelayMs	string (int64)

AlertParameter

Field	Description
doubleParameterValue	DoubleParameterValue Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`.
integerParameterValue	IntegerParameterValue Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`.
textParameterValue	TextParameterValue Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`.
textListParameterValue	TextListParameterValue Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`.
labelListParameterValue	LabelListParameterValue Includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`.

DoubleParameterValue

Field

Description

name

string

Required. Parameter name

value

string

Required. Parameter value

IntegerParameterValue

Field

Description

name

string

Required. Parameter name

value

string (int64)

Required. Parameter value

TextParameterValue

Field

Description

name

string

Required. Parameter name

value

string

Required. Parameter value

TextListParameterValue

Field

Description

name

string

Required. Parameter name

values[]

string

Required. Parameter value

LabelListParameterValue

Field

Description

name

string

Required. Parameter name

values[]

string

Required. Parameter value

Managed Service for YDB API, REST: Database.Get

HTTP requestHTTP request

Path parametersPath parameters

ResponseResponse

StorageConfigStorageConfig

StorageOptionStorageOption

ScalePolicyScalePolicy

FixedScaleFixedScale

ZonalDatabaseZonalDatabase

RegionalDatabaseRegionalDatabase

DedicatedDatabaseDedicatedDatabase

ServerlessDatabaseServerlessDatabase

BackupConfigBackupConfig

BackupSettingsBackupSettings

BackupScheduleBackupSchedule

DailyBackupScheduleDailyBackupSchedule

TimeOfDayTimeOfDay

WeeklyBackupScheduleWeeklyBackupSchedule

DaysOfWeekBackupScheduleDaysOfWeekBackupSchedule

RecurringBackupScheduleRecurringBackupSchedule

MonitoringConfigMonitoringConfig

AlertAlert

NotificationChannelNotificationChannel

AlertParameterAlertParameter

DoubleParameterValueDoubleParameterValue

IntegerParameterValueIntegerParameterValue

TextParameterValueTextParameterValue

TextListParameterValueTextListParameterValue

LabelListParameterValueLabelListParameterValue

Was the article helpful?

HTTP request

Path parameters

Response

StorageConfig

StorageOption

ScalePolicy

FixedScale

ZonalDatabase

RegionalDatabase

DedicatedDatabase

ServerlessDatabase

BackupConfig

BackupSettings

BackupSchedule

DailyBackupSchedule

TimeOfDay

WeeklyBackupSchedule

DaysOfWeekBackupSchedule

RecurringBackupSchedule

MonitoringConfig

Alert

NotificationChannel

AlertParameter

DoubleParameterValue

IntegerParameterValue

TextParameterValue

TextListParameterValue

LabelListParameterValue