Network Load Balancer API, gRPC: NetworkLoadBalancerService.Update
Updates the specified network load balancer.
gRPC request
rpc Update (UpdateNetworkLoadBalancerRequest) returns (operation.Operation)
UpdateNetworkLoadBalancerRequest
{
"networkLoadBalancerId": "string",
"updateMask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "string",
"listenerSpecs": [
{
"name": "string",
"port": "int64",
"protocol": "Protocol",
// Includes only one of the fields `externalAddressSpec`, `internalAddressSpec`
"externalAddressSpec": {
"address": "string",
"ipVersion": "IpVersion"
},
"internalAddressSpec": {
"address": "string",
"subnetId": "string",
"ipVersion": "IpVersion"
},
// end of the list of possible fields
"targetPort": "int64"
}
],
"attachedTargetGroups": [
{
"targetGroupId": "string",
"healthChecks": [
{
"name": "string",
"interval": "google.protobuf.Duration",
"timeout": "google.protobuf.Duration",
"unhealthyThreshold": "int64",
"healthyThreshold": "int64",
// Includes only one of the fields `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "int64"
},
"httpOptions": {
"port": "int64",
"path": "string"
}
// end of the list of possible fields
}
]
}
],
"deletionProtection": "bool"
}
Field |
Description |
networkLoadBalancerId |
string Required field. ID of the network load balancer to update. |
updateMask |
Field mask that specifies which fields of the NetworkLoadBalancer resource are going to be updated. |
name |
string Name of the network load balancer. |
description |
string Description of the network load balancer. |
labels |
string Resource labels as The existing set of |
listenerSpecs[] |
A list of listeners and their specs for the network load balancer. |
attachedTargetGroups[] |
A list of attached target groups for the network load balancer. |
deletionProtection |
bool Specifies if network load balancer protected from deletion. |
ListenerSpec
Listener specification that will be used by a network load balancer.
Field |
Description |
name |
string Required field. Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long. |
port |
int64 Port for incoming traffic. |
protocol |
enum Protocol Required field. Protocol for incoming traffic.
|
externalAddressSpec |
External IP address specification. Includes only one of the fields IP address for incoming traffic. Either the ID of the previously created address or the address specification. |
internalAddressSpec |
Internal IP address specification. Includes only one of the fields IP address for incoming traffic. Either the ID of the previously created address or the address specification. |
targetPort |
int64 Port of a target. |
ExternalAddressSpec
External address specification that is used by ListenerSpec.
Field |
Description |
address |
string Public IP address for a listener. |
ipVersion |
enum IpVersion IP version.
|
InternalAddressSpec
Internal address specification that is used by ListenerSpec.
Field |
Description |
address |
string Internal IP address for a listener. |
subnetId |
string ID of the subnet. |
ipVersion |
enum IpVersion IP version.
|
AttachedTargetGroup
An AttachedTargetGroup resource. For more information, see Targets and groups.
Field |
Description |
targetGroupId |
string Required field. ID of the target group. |
healthChecks[] |
A health check to perform on the target group. |
HealthCheck
A HealthCheck resource. For more information, see Health check.
Field |
Description |
name |
string Required field. 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. |
interval |
The interval between health checks. The default is 2 seconds. |
timeout |
Timeout for a target to return a response for the health check. The default is 1 second. |
unhealthyThreshold |
int64 Number of failed health checks before changing the status to |
healthyThreshold |
int64 Number of successful health checks required in order to set the |
tcpOptions |
Options for TCP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
httpOptions |
Options for HTTP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
TcpOptions
Configuration option for a TCP health check.
Field |
Description |
port |
int64 Port to use for TCP health checks. |
HttpOptions
Configuration option for an HTTP health check.
Field |
Description |
port |
int64 Port to use for HTTP health checks. |
path |
string URL path to set for health checking requests for every target in the target group. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"networkLoadBalancerId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"regionId": "string",
"status": "Status",
"type": "Type",
"sessionAffinity": "SessionAffinity",
"listeners": [
{
"name": "string",
"address": "string",
"port": "int64",
"protocol": "Protocol",
"targetPort": "int64",
"subnetId": "string",
"ipVersion": "IpVersion"
}
],
"attachedTargetGroups": [
{
"targetGroupId": "string",
"healthChecks": [
{
"name": "string",
"interval": "google.protobuf.Duration",
"timeout": "google.protobuf.Duration",
"unhealthyThreshold": "int64",
"healthyThreshold": "int64",
// Includes only one of the fields `tcpOptions`, `httpOptions`
"tcpOptions": {
"port": "int64"
},
"httpOptions": {
"port": "int64",
"path": "string"
}
// end of the list of possible fields
}
]
}
],
"deletionProtection": "bool"
}
// 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 |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
UpdateNetworkLoadBalancerMetadata Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateNetworkLoadBalancerMetadata
Field |
Description |
networkLoadBalancerId |
string ID of the NetworkLoadBalancer resource that is being updated. |
NetworkLoadBalancer
A NetworkLoadBalancer resource. For more information, see Network Load Balancer.
Field |
Description |
id |
string ID of the network load balancer. |
folderId |
string ID of the folder that the network load balancer belongs to. |
createdAt |
Creation timestamp in RFC3339 |
name |
string Name of the network load balancer. The name is unique within the folder. 3-63 characters long. |
description |
string Optional description of the network load balancer. 0-256 characters long. |
labels |
string Resource labels as |
regionId |
string ID of the region that the network load balancer belongs to. |
status |
enum Status Status of the network load balancer.
|
type |
enum Type Type of the network load balancer. Only external network load balancers are available now.
|
sessionAffinity |
enum SessionAffinity Type of the session affinity. Only 5-tuple affinity is available now.
|
listeners[] |
List of listeners for the network load balancer. |
attachedTargetGroups[] |
List of target groups attached to the network load balancer. |
deletionProtection |
bool Specifies if network load balancer protected from deletion. |
Listener
A Listener resource. For more information, see Listener
Field |
Description |
name |
string Name of the listener. The name must be unique for each listener on a single load balancer. 3-63 characters long. |
address |
string IP address for the listener. |
port |
int64 Port. |
protocol |
enum Protocol Network protocol for incoming traffic.
|
targetPort |
int64 Port of a target. |
subnetId |
string ID of the subnet. |
ipVersion |
enum IpVersion IP version of the external address.
|
AttachedTargetGroup
An AttachedTargetGroup resource. For more information, see Targets and groups.
Field |
Description |
targetGroupId |
string Required field. ID of the target group. |
healthChecks[] |
A health check to perform on the target group. |
HealthCheck
A HealthCheck resource. For more information, see Health check.
Field |
Description |
name |
string Required field. 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. |
interval |
The interval between health checks. The default is 2 seconds. |
timeout |
Timeout for a target to return a response for the health check. The default is 1 second. |
unhealthyThreshold |
int64 Number of failed health checks before changing the status to |
healthyThreshold |
int64 Number of successful health checks required in order to set the |
tcpOptions |
Options for TCP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
httpOptions |
Options for HTTP health check. Includes only one of the fields Protocol to use for the health check. Either TCP or HTTP. |
TcpOptions
Configuration option for a TCP health check.
Field |
Description |
port |
int64 Port to use for TCP health checks. |
HttpOptions
Configuration option for an HTTP health check.
Field |
Description |
port |
int64 Port to use for HTTP health checks. |
path |
string URL path to set for health checking requests for every target in the target group. |