Suspend a warehouse

Suspends a warehouse.

NOTE

This operation requires the Suspend & resume cluster privilege.

You cannot suspend or resume the default warehouse.

Request

Basic information
HTTP URL	`https://cloud-api.celerdata.com/api/1.0/warehouses/:warehouse_id/suspend`
HTTP method	PATCH
Frequency	600/minute

Parameter	Example value	Required	Type	Description
warehouse_id	ff09d6ac-b821-447d-b4c1-59167d022c8b	Yes	String	The ID of the warehouse.

Parameter	Example value	Required	Type	Description
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	Yes	String	The access token used to access the CelerData Cloud BYOC API. Format: `Bearer <access_token>`.

{
    "code": 20000,
    "data": {
        "action_id": "9d71aae6-a35da-40d5-b213-27bb1f57ifj5"
    }
}

Parameter	Example value	Type	Description
code	20000	Integer	The error code. If the error code returned is `20000`, the request succeeded. If any other error code is returned, the request failed.
data	-	Object	The result of the API call. The data object may not be returned for some API actions. It consists of the following element: `action_id`.
data.action_id	-	String	The ID of the action.
message	-	String	The error message. This element is returned only when the `code` returned is not `20000`. NOTICE Do not conclude whether a request succeeded or failed based on the return value of `message`.