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

    Interface ResizeRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/resize

    interface ResizeRequestBuilder {
        put(
            body: Database_cluster_resize,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toPutRequestInformation(
            body: Database_cluster_resize,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ResizeRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    put toPutRequestInformation withUrl

    Methods

    • To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes.A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed.

      Parameters

      • body: Database_cluster_resize

        The request body

      • 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 resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes.A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed.

      Parameters

      • body: Database_cluster_resize

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ResizeRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods