Method addListener

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

HTTP request
Path parameters
Body parameters
Response

Adds a listener to the specified network load balancer.

HTTP request

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

Path parameters

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

Body parameters

{
  "listenerSpec": {
    "name": "string",
    "port": "string",
    "protocol": "string",
    "targetPort": "string",

    // `listenerSpec` 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`listenerSpec`

  }
}

Field	Description
listenerSpec	object Required. Listener spec. Listener specification that will be used by a network load balancer.
listenerSpec. 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]`.
listenerSpec. port	string (int64) Port for incoming traffic. Acceptable values are 1 to 65535, inclusive.
listenerSpec. protocol	string Required. Protocol for incoming traffic. Network protocol to use.
listenerSpec. targetPort	string (int64) Port of a target. Acceptable values are 1 to 65535, inclusive.
listenerSpec. externalAddressSpec	object External IP address specification. `listenerSpec` includes only one of the fields `externalAddressSpec`, `internalAddressSpec` External address specification that is used by `ListenerSpec`.
listenerSpec. 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.
listenerSpec. 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
listenerSpec. internalAddressSpec	object Internal IP address specification. `listenerSpec` includes only one of the fields `externalAddressSpec`, `internalAddressSpec` Internal address specification that is used by `ListenerSpec`.
listenerSpec. internalAddressSpec. address	string Internal IP address for a listener.
listenerSpec. internalAddressSpec. subnetId	string ID of the subnet.
listenerSpec. 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

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.

Method addListener

HTTP request

Path parameters

Body parameters

Response

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