Подключиться
Language / Region
© 2021 ООО «Яндекс.Облако»
Yandex Network Load Balancer

Method update

Статья создана

Updates the specified network load balancer.

HTTP request

PATCH https://load-balancer.api.cloud.yandex.net/load-balancer/v1/networkLoadBalancers/{networkLoadBalancerId}

Path parameters

Parameter Description
networkLoadBalancerId Required. ID of the network load balancer to update. To get the network load balancer ID, use a list request. The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "listenerSpecs": [
    {
      "name": "string",
      "port": "string",
      "protocol": "string",
      "targetPort": "string",

      // `listenerSpecs[]` includes only one of the fields `externalAddressSpec`, `internalAddressSpec`
      "externalAddressSpec": {
        "address": "string",
        "ipVersion": "string"
      },
      "internalAddressSpec": {
        "address": "string",
        "subnetId": "string",
        "ipVersion": "string"
      },
      // end of the list of possible fields`listenerSpecs[]`

    }
  ],
  "attachedTargetGroups": [
    {
      "targetGroupId": "string",
      "healthChecks": [
        {
          "name": "string",
          "interval": "string",
          "timeout": "string",
          "unhealthyThreshold": "string",
          "healthyThreshold": "string",

          // `attachedTargetGroups[].healthChecks[]` includes only one of the fields `tcpOptions`, `httpOptions`
          "tcpOptions": {
            "port": "string"
          },
          "httpOptions": {
            "port": "string",
            "path": "string"
          },
          // end of the list of possible fields`attachedTargetGroups[].healthChecks[]`

        }
      ]
    }
  ]
}
Field Description
updateMask string

Field mask that specifies which fields of the NetworkLoadBalancer resource are going to be updated.

A comma-separated names off ALL fields to be updated. Оnly 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

Name of the network load balancer. The name must be unique within the folder.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string

Description of the network load balancer.

The maximum string length in characters is 256.
labels object

Resource labels as key:value pairs.

The existing set of labels is completely replaced with the provided set.

No more than 64 per resource. The string length in characters for each key must be 1-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]*.
listenerSpecs[] object

Listener specification that will be used by a network load balancer.
listenerSpecs[].
name		 string

Required. Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
listenerSpecs[].
port		 string (int64)

Port for incoming traffic.

Acceptable values are 1 to 65535, inclusive.
listenerSpecs[].
protocol		 string
Required. Protocol for incoming traffic.

Network protocol to use.
listenerSpecs[].
targetPort		 string (int64)

Port of a target. Acceptable values are 1 to 65535, inclusive.
listenerSpecs[].
externalAddressSpec		 object
External IP address specification.
listenerSpecs[] includes only one of the fields externalAddressSpec, internalAddressSpec

External address specification that is used by ListenerSpec.
listenerSpecs[].
externalAddressSpec.
address		 string

Public IP address for a listener. If you provide a static public IP address for the update method, it will replace the existing listener address.
listenerSpecs[].
externalAddressSpec.
ipVersion		 string

IP version.

IP version of the addresses that the load balancer works with. Only IPv4 is currently available.

  • IPV4: IPv4
  • IPV6: IPv6
listenerSpecs[].
internalAddressSpec		 object
Internal IP address specification.
listenerSpecs[] includes only one of the fields externalAddressSpec, internalAddressSpec

Internal address specification that is used by ListenerSpec.
listenerSpecs[].
internalAddressSpec.
address		 string

Internal IP address for a listener.
listenerSpecs[].
internalAddressSpec.
subnetId		 string

ID of the subnet.
listenerSpecs[].
internalAddressSpec.
ipVersion		 string

IP version.

IP version of the addresses that the load balancer works with. Only IPv4 is currently available.

  • IPV4: IPv4
  • IPV6: IPv6
attachedTargetGroups[] object

An AttachedTargetGroup resource. For more information, see Targets and groups.
attachedTargetGroups[].
targetGroupId		 string

Required. ID of the target group.

The maximum string length in characters is 50.
attachedTargetGroups[].
healthChecks[]		 object

A HealthCheck resource. For more information, see Health check.
attachedTargetGroups[].
healthChecks[].
name		 string

Required. Name of the health check. The name must be unique for each target group that attached to a single load balancer. 3-63 characters long.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
attachedTargetGroups[].
healthChecks[].
interval		 string

The interval between health checks. The default is 2 seconds.
attachedTargetGroups[].
healthChecks[].
timeout		 string

Timeout for a target to return a response for the health check. The default is 1 second.
attachedTargetGroups[].
healthChecks[].
unhealthyThreshold		 string (int64)

Number of failed health checks before changing the status to UNHEALTHY. The default is 2.

Acceptable values are 2 to 10, inclusive.
attachedTargetGroups[].
healthChecks[].
healthyThreshold		 string (int64)

Number of successful health checks required in order to set the HEALTHY status for the target. The default is 2.

Acceptable values are 2 to 10, inclusive.
attachedTargetGroups[].
healthChecks[].
tcpOptions		 object
Options for TCP health check.
attachedTargetGroups[].healthChecks[] includes only one of the fields tcpOptions, httpOptions

Configuration option for a TCP health check.
attachedTargetGroups[].
healthChecks[].
tcpOptions.
port		 string (int64)

Port to use for TCP health checks.

Acceptable values are 1 to 65535, inclusive.
attachedTargetGroups[].
healthChecks[].
httpOptions		 object
Options for HTTP health check.
attachedTargetGroups[].healthChecks[] includes only one of the fields tcpOptions, httpOptions

Configuration option for an HTTP health check.
attachedTargetGroups[].
healthChecks[].
httpOptions.
port		 string (int64)

Port to use for HTTP health checks.

Acceptable values are 1 to 65535, inclusive.
attachedTargetGroups[].
healthChecks[].
httpOptions.
path		 string

URL path to set for health checking requests for every target in the target group. For example /ping. The default path is /.

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

The error result of the operation in case of failure or cancellation.
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
© 2021 ООО «Яндекс.Облако»
В этой статье: