@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface Load_balancersRequestBuilder

    Builds and executes requests for operations under /v2/load_balancers

    interface Load_balancersRequestBuilder {
        byLb_id(lb_id: string): WithLb_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Load_balancersRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | Load_balancersGetResponse>;
        post(
            body: UntypedNode,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Load_balancersPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Load_balancersRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: UntypedNode,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Load_balancersRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byLb_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    post

    • post(
          body: UntypedNode,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Load_balancersPostResponse>

      To create a new load balancer instance, send a POST request to/v2/load_balancers.You can specify the Droplets that will sit behind the load balancer using oneof two methods:* Set droplet_ids to a list of specific Droplet IDs.* Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the load balancer. Additional Droplets will be automatically assigned as they are tagged.These methods are mutually exclusive.

      Parameters

      • body: UntypedNode

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | Load_balancersPostResponse>

      error when the service returns a 401 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To create a new load balancer instance, send a POST request to/v2/load_balancers.You can specify the Droplets that will sit behind the load balancer using oneof two methods:* Set droplet_ids to a list of specific Droplet IDs.* Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the load balancer. Additional Droplets will be automatically assigned as they are tagged.These methods are mutually exclusive.

      Parameters

      • body: UntypedNode

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods