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

    Interface WithAutoscale_pool_ItemRequestBuilder

    Builds and executes requests for operations under /v2/droplets/autoscale/{autoscale_pool_id}

    interface WithAutoscale_pool_ItemRequestBuilder {
        get dangerous(): DangerousRequestBuilder;
        get history(): HistoryRequestBuilder;
        get members(): MembersRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAutoscale_pool_GetResponse>;
        put(
            body: Autoscale_pool_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithAutoscale_pool_PutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Autoscale_pool_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithAutoscale_pool_ItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    dangerous history members

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To destroy an autoscale pool, send a DELETE request to the /v2/droplets/autoscale/$AUTOSCALE_POOL_ID endpoint.A successful response will include a 202 response code and no content.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 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 show information about an individual autoscale pool, send a GET request to/v2/droplets/autoscale/$AUTOSCALE_POOL_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithAutoscale_pool_GetResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 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 update the configuration of an existing autoscale pool, send a PUT request to/v2/droplets/autoscale/$AUTOSCALE_POOL_ID. The request must contain a full representationof the autoscale pool including existing attributes.

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

      error when the service returns a 401 status code

      error when the service returns a 404 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 destroy an autoscale pool, send a DELETE request to the /v2/droplets/autoscale/$AUTOSCALE_POOL_ID endpoint.A successful response will include a 202 response code and no content.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To show information about an individual autoscale pool, send a GET request to/v2/droplets/autoscale/$AUTOSCALE_POOL_ID.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the configuration of an existing autoscale pool, send a PUT request to/v2/droplets/autoscale/$AUTOSCALE_POOL_ID. The request must contain a full representationof the autoscale pool including existing attributes.

      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

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods