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

    Interface AutoscaleRequestBuilder

    Builds and executes requests for operations under /v2/droplets/autoscale

    interface AutoscaleRequestBuilder {
        byAutoscale_pool_id(
            autoscale_pool_id: string,
        ): WithAutoscale_pool_ItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                AutoscaleRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | AutoscaleGetResponse>;
        post(
            body: Autoscale_pool_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | AutoscalePostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AutoscaleRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: Autoscale_pool_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AutoscaleRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAutoscale_pool_id get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all autoscale pools in your team, send a GET request to /v2/droplets/autoscale.The response body will be a JSON object with a key of autoscale_pools containing an array of autoscale pool objects.These each contain the standard autoscale pool attributes.

      Parameters

      Returns Promise<undefined | AutoscaleGetResponse>

      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

    post

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

      To create a new autoscale pool, send a POST request to /v2/droplets/autoscale setting the required attributes.The response body will contain a JSON object with a key called autoscale_pool containing the standard attributes for the new autoscale pool.

      Parameters

      • body: Autoscale_pool_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | AutoscalePostResponse>

      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 list all autoscale pools in your team, send a GET request to /v2/droplets/autoscale.The response body will be a JSON object with a key of autoscale_pools containing an array of autoscale pool objects.These each contain the standard autoscale pool attributes.

      Parameters

      Returns RequestInformation

    • To create a new autoscale pool, send a POST request to /v2/droplets/autoscale setting the required attributes.The response body will contain a JSON object with a key called autoscale_pool containing the standard attributes for the new autoscale pool.

      Parameters

      • body: Autoscale_pool_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns AutoscaleRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods