Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Managed Service for Redis
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Изменение настроек кластера и базы данных
    • Подключение к базе данных
      • Подготовка к подключению
      • Подключение к нешардированному кластеру
      • Подключение к шардированному кластеру
    • Остановка и запуск кластера
    • Обновление версии Redis
    • Управление хостами кластера
    • Управление шардами
    • Управление резервными копиями
    • Переключение мастера
    • Мониторинг состояния кластера и хостов
    • Просмотр логов кластера
    • Удаление кластера
  • Практические руководства
    • Все сценарии
    • Хранение сессий PHP в Managed Service for Redis
    • Миграция базы данных в Managed Service for Redis
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
    • Сеть в Managed Service for Redis
    • Шардирование
    • Резервные копии
    • Репликация и отказоустойчивость
    • Поддерживаемые клиенты
    • Управление памятью в Managed Service for Redis
    • Доступные команды Managed Service for Redis
    • Квоты и лимиты
    • Типы диска
    • Техническое обслуживание
    • Настройки Redis
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 февраля 2020 года
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • BackupService
      • ClusterService
      • ResourcePresetService
      • OperationService
    • REST (англ.)
      • Overview
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • backup
        • create
        • delete
        • deleteHosts
        • deleteShard
        • get
        • getShard
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • listShards
        • move
        • rebalance
        • rescheduleMaintenance
        • restore
        • start
        • startFailover
        • stop
        • streamLogs
        • update
        • updateHosts
      • ResourcePreset
        • Overview
        • get
        • list
      • Operation
        • Overview
        • get
  • История изменений
  • Вопросы и ответы
    • Общие вопросы
  1. Справочник API
  2. REST (англ.)
  3. Cluster
  4. update

Managed Service for Redis API, REST: Cluster.update

Статья создана
Yandex Cloud
,
улучшена
amatol
  • HTTP request
  • Path parameters
  • Body parameters
  • Response

Updates the specified Redis cluster.

HTTP request

PATCH https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}

Path parameters

Parameter Description
clusterId

Required. ID of the Redis cluster to update. To get the Redis cluster ID, use a list request.

The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `configSpec` includes only one of the fields `redisConfig_5_0`, `redisConfig_6_0`, `redisConfig_6_2`, `redisConfig_7_0`
    "redisConfig_5_0": {
      "maxmemoryPolicy": "string",
      "timeout": "integer",
      "password": "string",
      "databases": "integer",
      "slowlogLogSlowerThan": "integer",
      "slowlogMaxLen": "integer",
      "notifyKeyspaceEvents": "string",
      "clientOutputBufferLimitPubsub": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      },
      "clientOutputBufferLimitNormal": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      }
    },
    "redisConfig_6_0": {
      "maxmemoryPolicy": "string",
      "timeout": "integer",
      "password": "string",
      "databases": "integer",
      "slowlogLogSlowerThan": "integer",
      "slowlogMaxLen": "integer",
      "notifyKeyspaceEvents": "string",
      "clientOutputBufferLimitPubsub": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      },
      "clientOutputBufferLimitNormal": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      }
    },
    "redisConfig_6_2": {
      "maxmemoryPolicy": "string",
      "timeout": "integer",
      "password": "string",
      "databases": "integer",
      "slowlogLogSlowerThan": "integer",
      "slowlogMaxLen": "integer",
      "notifyKeyspaceEvents": "string",
      "clientOutputBufferLimitPubsub": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      },
      "clientOutputBufferLimitNormal": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      }
    },
    "redisConfig_7_0": {
      "maxmemoryPolicy": "string",
      "timeout": "integer",
      "password": "string",
      "databases": "integer",
      "slowlogLogSlowerThan": "integer",
      "slowlogMaxLen": "integer",
      "notifyKeyspaceEvents": "string",
      "clientOutputBufferLimitPubsub": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      },
      "clientOutputBufferLimitNormal": {
        "hardLimit": "integer",
        "softLimit": "integer",
        "softSeconds": "integer"
      }
    },
    // end of the list of possible fields`configSpec`

  },
  "name": "string",
  "maintenanceWindow": {

    // `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": {},
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    },
    // end of the list of possible fields`maintenanceWindow`

  },
  "securityGroupIds": [
    "string"
  ],
  "deletionProtection": true,
  "persistenceMode": "string",
  "announceHostnames": true
}
Field Description
updateMask string

Field mask that specifies which fields of the Redis cluster should be updated.

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.

description string

New description of the Redis cluster.

The maximum string length in characters is 256.

labels object

Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster. For example, "project": "mvp" or "source": "dictionary".

The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the set.

No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.

configSpec object

New configuration and resources for hosts in the cluster.

configSpec.
version
string

Version of Redis used in the cluster.

configSpec.
resources
object
Resources allocated to Redis hosts.
configSpec.
resources.
resourcePresetId
string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

configSpec.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
configSpec.
backupWindowStart
object
Time to start the daily backup, in the UTC timezone.
configSpec.
backupWindowStart.
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.

configSpec.
backupWindowStart.
minutes
integer (int32)

Minutes of hour of day. Must be from 0 to 59.

configSpec.
backupWindowStart.
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.

configSpec.
backupWindowStart.
nanos
integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

configSpec.
access
object
Access policy to DB
configSpec.
access.
dataLens
boolean (boolean)

Allow access for DataLens

configSpec.
redisConfig_5_0
object
configSpec includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0

Fields and structure of RedisConfig reflects Redis configuration file parameters.

configSpec.
redisConfig_5_0.
maxmemoryPolicy
string

Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class.

All policies are described in detail in Redis documentation.

  • VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
  • ALLKEYS_LRU: Remove less recently used (LRU) keys.
  • VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
  • ALLKEYS_LFU: Remove least frequently used (LFU) keys.
  • VOLATILE_RANDOM: Try to remove keys with expire set randomly.
  • ALLKEYS_RANDOM: Remove keys randomly.
  • VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set and shorter TTL first.
  • NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
configSpec.
redisConfig_5_0.
timeout
integer (int64)

Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.

configSpec.
redisConfig_5_0.
password
string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

configSpec.
redisConfig_5_0.
databases
integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

configSpec.
redisConfig_5_0.
slowlogLogSlowerThan
integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

configSpec.
redisConfig_5_0.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

configSpec.
redisConfig_5_0.
notifyKeyspaceEvents
string

String setting for pub\sub functionality; subset of KEg$lshzxeAt.

Value must match the regular expression [KEg$lshzxeAt]{0,12}.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_5_0.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_6_0
object
configSpec includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0

Fields and structure of RedisConfig reflects Redis configuration file parameters.

configSpec.
redisConfig_6_0.
maxmemoryPolicy
string

Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class.

All policies are described in detail in Redis documentation.

  • VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
  • ALLKEYS_LRU: Remove less recently used (LRU) keys.
  • VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
  • ALLKEYS_LFU: Remove least frequently used (LFU) keys.
  • VOLATILE_RANDOM: Try to remove keys with expire set randomly.
  • ALLKEYS_RANDOM: Remove keys randomly.
  • VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set and shorter TTL first.
  • NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
configSpec.
redisConfig_6_0.
timeout
integer (int64)

Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.

configSpec.
redisConfig_6_0.
password
string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

configSpec.
redisConfig_6_0.
databases
integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

configSpec.
redisConfig_6_0.
slowlogLogSlowerThan
integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

configSpec.
redisConfig_6_0.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

configSpec.
redisConfig_6_0.
notifyKeyspaceEvents
string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_6_0.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_6_2
object
configSpec includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0

Fields and structure of RedisConfig reflects Redis configuration file parameters.

configSpec.
redisConfig_6_2.
maxmemoryPolicy
string

Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class.

All policies are described in detail in Redis documentation.

  • VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
  • ALLKEYS_LRU: Remove less recently used (LRU) keys.
  • VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
  • ALLKEYS_LFU: Remove least frequently used (LFU) keys.
  • VOLATILE_RANDOM: Try to remove keys with expire set randomly.
  • ALLKEYS_RANDOM: Remove keys randomly.
  • VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set and shorter TTL first.
  • NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
configSpec.
redisConfig_6_2.
timeout
integer (int64)

Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.

configSpec.
redisConfig_6_2.
password
string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

configSpec.
redisConfig_6_2.
databases
integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

configSpec.
redisConfig_6_2.
slowlogLogSlowerThan
integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

configSpec.
redisConfig_6_2.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

configSpec.
redisConfig_6_2.
notifyKeyspaceEvents
string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_6_2.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_7_0
object
configSpec includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0

Fields and structure of RedisConfig reflects Redis configuration file parameters.

configSpec.
redisConfig_7_0.
maxmemoryPolicy
string

Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class.

All policies are described in detail in Redis documentation.

  • VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
  • ALLKEYS_LRU: Remove less recently used (LRU) keys.
  • VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
  • ALLKEYS_LFU: Remove least frequently used (LFU) keys.
  • VOLATILE_RANDOM: Try to remove keys with expire set randomly.
  • ALLKEYS_RANDOM: Remove keys randomly.
  • VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set and shorter TTL first.
  • NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
configSpec.
redisConfig_7_0.
timeout
integer (int64)

Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.

configSpec.
redisConfig_7_0.
password
string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

configSpec.
redisConfig_7_0.
databases
integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

configSpec.
redisConfig_7_0.
slowlogLogSlowerThan
integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

configSpec.
redisConfig_7_0.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

configSpec.
redisConfig_7_0.
notifyKeyspaceEvents
string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

configSpec.
redisConfig_7_0.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

name string

New name for the cluster.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

maintenanceWindow object

New maintenance window settings for the cluster.

A maintenance window settings.

maintenanceWindow.
anytime
object
Maintenance operation can be scheduled anytime.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow
object
Maintenance operation can be scheduled on a weekly basis.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow.
day
string

Day of the week (in DDD format).

maintenanceWindow.
weeklyMaintenanceWindow.
hour
string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.

securityGroupIds[] string

User security groups

deletionProtection boolean (boolean)

Deletion Protection inhibits deletion of the cluster

persistenceMode string

Persistence mode

announceHostnames boolean (boolean)

Enable FQDN instead of ip

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.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Path parameters
  • Body parameters
  • Response