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 URLhttps://cloud-api.celerdata.com/api/1.0/warehouses/:warehouse_id/suspend
HTTP methodPATCH
Frequency600/minute

Path variables

ParameterExample valueRequiredTypeDescription
warehouse_idff09d6ac-b821-447d-b4c1-59167d022c8bYesStringThe ID of the warehouse.

Header parameters

ParameterExample valueRequiredTypeDescription
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYYesStringThe access token used to access the CelerData Cloud BYOC API. Format: Bearer <access_token>.

See Obtain access token.

Response

Sample response

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

Response elements

ParameterExample valueTypeDescription
code20000IntegerThe error code. If the error code returned is 20000, the request succeeded. If any other error code is returned, the request failed.
data-ObjectThe 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-StringThe ID of the action.
message-StringThe 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.

See also

Suspending a warehouse may take a few minutes. After you make the preceding API call, you can query the status of the warehouse by following the instructions provided in Query a warehouse.