Managed Service for YDB API, REST: Database.List
- HTTP request
- Query parameters
- Response
- Database
- 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
Retrieves a list of databases.
HTTP request
GET https://ydb.api.cloud.yandex.net/ydb/v1/databases
Query parameters
Field |
Description |
folderId |
string |
pageSize |
string (int64) The maximum number of results per page that should be returned. If the number of available |
pageToken |
string Page token. Set |
Response
HTTP Code: 200 - OK
{
"databases": [
{
"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"
}
],
"nextPageToken": "string"
}
Field |
Description |
databases[] |
|
nextPageToken |
string This token allows you to get the next page of results for ListDatabases requests, |
Database
YDB database.
Field |
Description |
id |
string |
folderId |
string |
createdAt |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string |
description |
string |
status |
enum (Status)
|
endpoint |
string |
resourcePresetId |
string |
storageConfig |
|
scalePolicy |
|
networkId |
string |
subnetIds[] |
string |
zonalDatabase |
deprecated field Includes only one of the fields |
regionalDatabase |
deprecated field Includes only one of the fields |
dedicatedDatabase |
Includes only one of the fields |
serverlessDatabase |
Includes only one of the fields |
assignPublicIps |
boolean |
locationId |
string |
labels |
string |
backupConfig |
|
documentApiEndpoint |
string |
kinesisApiEndpoint |
string |
kafkaApiEndpoint |
string |
monitoringConfig |
|
deletionProtection |
boolean |
StorageConfig
Field |
Description |
storageOptions[] |
|
storageSizeLimit |
string (int64) output only field: storage size limit of dedicated database. |
StorageOption
Field |
Description |
storageTypeId |
string |
groupCount |
string (int64) |
ScalePolicy
Field |
Description |
fixedScale |
Includes only one of the fields |
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 |
|
scalePolicy |
|
networkId |
string |
subnetIds[] |
string |
assignPublicIps |
boolean |
ServerlessDatabase
Field |
Description |
throttlingRcuLimit |
string (int64) Let's define 1 RU - 1 request unit |
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. |
topicWriteQuota |
string (int64) write quota for topic service, defined in bytes per second. |
BackupConfig
Field |
Description |
backupSettings[] |
BackupSettings
Field |
Description |
name |
string name of backup settings |
description |
string human readable description. |
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. |
sourcePathsToExclude[] |
string provide a list of paths to exclude from backup. |
type |
enum (Type)
|
storageClass |
enum (StorageClass)
|
BackupSchedule
Field |
Description |
dailyBackupSchedule |
Includes only one of the fields |
weeklyBackupSchedule |
Includes only one of the fields |
recurringBackupSchedule |
Includes only one of the fields |
nextExecuteTime |
string (date-time) output only field: when next backup will be executed String in RFC3339 To work with values in this field, use the APIs described in the |
DailyBackupSchedule
Field |
Description |
executeTime |
Required field. |
TimeOfDay
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
Field |
Description |
hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
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 |
nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
WeeklyBackupSchedule
Field |
Description |
daysOfWeek[] |
DaysOfWeekBackupSchedule
Field |
Description |
days[] |
enum (DayOfWeek)
|
executeTime |
Required field. |
RecurringBackupSchedule
Field |
Description |
startTime |
string (date-time) Required field. Timestamp of the first recurrence. String in RFC3339 To work with values in this field, use the APIs described in the |
recurrence |
string Required field. An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |
MonitoringConfig
Field |
Description |
alerts[] |
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[] |
the notification channels of the alert. |
alertParameters[] |
alert parameters to override. |
alertThresholds[] |
alert paratemers to override. |
NotificationChannel
Field |
Description |
notificationChannelId |
string |
notifyAboutStatuses[] |
enum (AlertEvaluationStatus)
|
repeateNotifyDelayMs |
string (int64) |
AlertParameter
Field |
Description |
doubleParameterValue |
Includes only one of the fields |
integerParameterValue |
Includes only one of the fields |
textParameterValue |
Includes only one of the fields |
textListParameterValue |
Includes only one of the fields |
labelListParameterValue |
Includes only one of the fields |
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 |