Связаться с намиПодключиться

Managed Service for YDB API, REST: Database.update

Статья создана
Обновлена 26 мая 2023 г.

Modifies the specified database.

HTTP request

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

Path parameters

Parameter Description
databaseId

Body parameters

{
  "folderId": "string",
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "resourcePresetId": "string",
  "storageConfig": {
    "storageOptions": [
      {
        "storageTypeId": "string",
        "groupCount": "string"
      }
    ],
    "storageSizeLimit": "string"
  },
  "scalePolicy": {
    "fixedScale": {
      "size": "string"
    }
  },
  "networkId": "string",
  "subnetIds": [
    "string"
  ],
  "assignPublicIps": true,
  "locationId": "string",
  "labels": "object",
  "backupConfig": {
    "backupSettings": [
      {
        "name": "string",
        "description": "string",
        "backupSchedule": {
          "nextExecuteTime": "string",

          // `backupConfig.backupSettings[].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`backupConfig.backupSettings[].backupSchedule`

        },
        "backupTimeToLive": "string",
        "sourcePaths": [
          "string"
        ],
        "sourcePathsToExclude": [
          "string"
        ],
        "type": "string",
        "storageClass": "string"
      }
    ]
  },
  "monitoringConfig": {
    "alerts": [
      {
        "alertId": "string",
        "alertTemplateId": "string",
        "name": "string",
        "description": "string",
        "notificationChannels": [
          {
            "notificationChannelId": "string",
            "notifyAboutStatuses": [
              "string"
            ],
            "repeateNotifyDelayMs": "string"
          }
        ],
        "alertParameters": [
          {

            // `monitoringConfig.alerts[].alertParameters[]` includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`
            "doubleParameterValue": {
              "name": "string",
              "value": "number"
            },
            "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`monitoringConfig.alerts[].alertParameters[]`

          }
        ],
        "alertThresholds": [
          {

            // `monitoringConfig.alerts[].alertThresholds[]` includes only one of the fields `doubleParameterValue`, `integerParameterValue`, `textParameterValue`, `textListParameterValue`, `labelListParameterValue`
            "doubleParameterValue": {
              "name": "string",
              "value": "number"
            },
            "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`monitoringConfig.alerts[].alertThresholds[]`

          }
        ]
      }
    ]
  },
  "deletionProtection": true,

  //  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": {
      "fixedScale": {
        "size": "string"
      }
    },
    "networkId": "string",
    "subnetIds": [
      "string"
    ],
    "assignPublicIps": true
  },
  "serverlessDatabase": {
    "throttlingRcuLimit": "string",
    "storageSizeLimit": "string",
    "enableThrottlingRcuLimit": true,
    "provisionedRcuLimit": "string",
    "topicWriteQuota": "string"
  },
  // end of the list of possible fields

}
Field Description
folderId string
updateMask string

A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name string
description string
resourcePresetId string
storageConfig object
storageConfig.
storageOptions[]		 object

Required. The minimum number of elements is 1.
storageConfig.
storageOptions[].
storageTypeId		 string
storageConfig.
storageOptions[].
groupCount		 string (int64)
storageConfig.
storageSizeLimit		 string (int64)

output only field: storage size limit of dedicated database.
scalePolicy object
scalePolicy.
fixedScale		 object
scalePolicy.
fixedScale.
size		 string (int64)

The minimum value is 1.
networkId string
subnetIds[] string
assignPublicIps boolean (boolean)
locationId string
labels object
backupConfig object
backupConfig.
backupSettings[]		 object
backupConfig.
backupSettings[].
name		 string

name of backup settings

The maximum string length in characters is 256.
backupConfig.
backupSettings[].
description		 string

human readable description.

The maximum string length in characters is 256.
backupConfig.
backupSettings[].
backupSchedule		 object

provide schedule. if empty, backup will be disabled.
backupConfig.
backupSettings[].
backupSchedule.
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).
backupConfig.
backupSettings[].
backupSchedule.
dailyBackupSchedule		 object
backupConfig.backupSettings[].backupSchedule includes only one of the fields dailyBackupSchedule, weeklyBackupSchedule, recurringBackupSchedule
backupConfig.
backupSettings[].
backupSchedule.
dailyBackupSchedule.
executeTime		 object

Required.

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.
backupConfig.
backupSettings[].
backupSchedule.
dailyBackupSchedule.
executeTime.
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.
backupConfig.
backupSettings[].
backupSchedule.
dailyBackupSchedule.
executeTime.
minutes		 integer (int32)

Minutes of hour of day. Must be from 0 to 59.
backupConfig.
backupSettings[].
backupSchedule.
dailyBackupSchedule.
executeTime.
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.
backupConfig.
backupSettings[].
backupSchedule.
dailyBackupSchedule.
executeTime.
nanos		 integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule		 object
backupConfig.backupSettings[].backupSchedule includes only one of the fields dailyBackupSchedule, weeklyBackupSchedule, recurringBackupSchedule
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[]		 object

Required. The number of elements must be in the range 1-7.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[].
days[]		 string

Required. The number of elements must be in the range 1-7.

  • 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.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[].
executeTime		 object

Required.

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.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[].
executeTime.
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.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[].
executeTime.
minutes		 integer (int32)

Minutes of hour of day. Must be from 0 to 59.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[].
executeTime.
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.
backupConfig.
backupSettings[].
backupSchedule.
weeklyBackupSchedule.
daysOfWeek[].
executeTime.
nanos		 integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
backupConfig.
backupSettings[].
backupSchedule.
recurringBackupSchedule		 object
backupConfig.backupSettings[].backupSchedule includes only one of the fields dailyBackupSchedule, weeklyBackupSchedule, recurringBackupSchedule
backupConfig.
backupSettings[].
backupSchedule.
recurringBackupSchedule.
startTime		 string (date-time)

Required. 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).
backupConfig.
backupSettings[].
backupSchedule.
recurringBackupSchedule.
recurrence		 string

Required. 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.
backupConfig.
backupSettings[].
backupTimeToLive		 string

provide time to live of backup.
backupConfig.
backupSettings[].
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.

The maximum number of elements is 256.
backupConfig.
backupSettings[].
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.

The maximum number of elements is 256.
backupConfig.
backupSettings[].
type		 string
backupConfig.
backupSettings[].
storageClass		 string
monitoringConfig object
monitoringConfig.
alerts[]		 object
monitoringConfig.
alerts[].
alertId		 string

output only field.
monitoringConfig.
alerts[].
alertTemplateId		 string

template of the alert.
monitoringConfig.
alerts[].
name		 string

name of the alert.
monitoringConfig.
alerts[].
description		 string

human readable description of the alert.
monitoringConfig.
alerts[].
notificationChannels[]		 object

the notification channels of the alert.
monitoringConfig.
alerts[].
notificationChannels[].
notificationChannelId		 string
monitoringConfig.
alerts[].
notificationChannels[].
notifyAboutStatuses[]		 string
monitoringConfig.
alerts[].
notificationChannels[].
repeateNotifyDelayMs		 string (int64)
monitoringConfig.
alerts[].
alertParameters[]		 object

alert parameters to override.
monitoringConfig.
alerts[].
alertParameters[].
doubleParameterValue		 object
monitoringConfig.alerts[].alertParameters[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertParameters[].
doubleParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertParameters[].
doubleParameterValue.
value		 number (double)

Required. Parameter value
monitoringConfig.
alerts[].
alertParameters[].
integerParameterValue		 object
monitoringConfig.alerts[].alertParameters[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertParameters[].
integerParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertParameters[].
integerParameterValue.
value		 string (int64)

Required. Parameter value
monitoringConfig.
alerts[].
alertParameters[].
textParameterValue		 object
monitoringConfig.alerts[].alertParameters[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertParameters[].
textParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertParameters[].
textParameterValue.
value		 string

Required. Parameter value
monitoringConfig.
alerts[].
alertParameters[].
textListParameterValue		 object
monitoringConfig.alerts[].alertParameters[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertParameters[].
textListParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertParameters[].
textListParameterValue.
values[]		 string

Required. Parameter value
monitoringConfig.
alerts[].
alertParameters[].
labelListParameterValue		 object
monitoringConfig.alerts[].alertParameters[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertParameters[].
labelListParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertParameters[].
labelListParameterValue.
values[]		 string

Required. Parameter value
monitoringConfig.
alerts[].
alertThresholds[]		 object

alert paratemers to override.
monitoringConfig.
alerts[].
alertThresholds[].
doubleParameterValue		 object
monitoringConfig.alerts[].alertThresholds[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertThresholds[].
doubleParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertThresholds[].
doubleParameterValue.
value		 number (double)

Required. Parameter value
monitoringConfig.
alerts[].
alertThresholds[].
integerParameterValue		 object
monitoringConfig.alerts[].alertThresholds[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertThresholds[].
integerParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertThresholds[].
integerParameterValue.
value		 string (int64)

Required. Parameter value
monitoringConfig.
alerts[].
alertThresholds[].
textParameterValue		 object
monitoringConfig.alerts[].alertThresholds[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertThresholds[].
textParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertThresholds[].
textParameterValue.
value		 string

Required. Parameter value
monitoringConfig.
alerts[].
alertThresholds[].
textListParameterValue		 object
monitoringConfig.alerts[].alertThresholds[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertThresholds[].
textListParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertThresholds[].
textListParameterValue.
values[]		 string

Required. Parameter value
monitoringConfig.
alerts[].
alertThresholds[].
labelListParameterValue		 object
monitoringConfig.alerts[].alertThresholds[] includes only one of the fields doubleParameterValue, integerParameterValue, textParameterValue, textListParameterValue, labelListParameterValue
monitoringConfig.
alerts[].
alertThresholds[].
labelListParameterValue.
name		 string

Required. Parameter name
monitoringConfig.
alerts[].
alertThresholds[].
labelListParameterValue.
values[]		 string

Required. Parameter value
deletionProtection boolean (boolean)
zonalDatabase object
deprecated field
includes only one of the fields zonalDatabase, regionalDatabase, dedicatedDatabase, serverlessDatabase
zonalDatabase.
zoneId		 string

Required.
regionalDatabase object
deprecated field
includes only one of the fields zonalDatabase, regionalDatabase, dedicatedDatabase, serverlessDatabase
regionalDatabase.
regionId		 string

Required.
dedicatedDatabase object
includes only one of the fields zonalDatabase, regionalDatabase, dedicatedDatabase, serverlessDatabase
dedicatedDatabase.
resourcePresetId		 string
dedicatedDatabase.
storageConfig		 object
dedicatedDatabase.
storageConfig.
storageOptions[]		 object

Required. The minimum number of elements is 1.
dedicatedDatabase.
storageConfig.
storageOptions[].
storageTypeId		 string
dedicatedDatabase.
storageConfig.
storageOptions[].
groupCount		 string (int64)
dedicatedDatabase.
storageConfig.
storageSizeLimit		 string (int64)

output only field: storage size limit of dedicated database.
dedicatedDatabase.
scalePolicy		 object
dedicatedDatabase.
scalePolicy.
fixedScale		 object
dedicatedDatabase.
scalePolicy.
fixedScale.
size		 string (int64)

The minimum value is 1.
dedicatedDatabase.
networkId		 string
dedicatedDatabase.
subnetIds[]		 string
dedicatedDatabase.
assignPublicIps		 boolean (boolean)
serverlessDatabase object
includes only one of the fields zonalDatabase, regionalDatabase, dedicatedDatabase, serverlessDatabase
serverlessDatabase.
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.
serverlessDatabase.
storageSizeLimit		 string (int64)

Specify serverless database storage size limit. If zero, default value is applied.
serverlessDatabase.
enableThrottlingRcuLimit		 boolean (boolean)

If false, the database is throttled by cloud value.
serverlessDatabase.
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.
serverlessDatabase.
topicWriteQuota		 string (int64)

write quota for topic service, defined in bytes per second.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.
description string

Description of the operation. 0-256 characters long.
createdAt string (date-time)

Creation timestamp.

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).
createdBy string

ID of the user or service account who initiated the operation.
modifiedAt string (date-time)

The time when the Operation resource was last modified.

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).
done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.
Предыдущая
stop
Следующая
Overview