Skip to main content

Apply static configurations

Applies the static configurations to the corresponding nodes in the cluster. You can use this API to apply the static configurations you made via the Terraform API celerdatabyoc_cluster_custom_config.

Request

Basic information
HTTP URLhttps://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/apply-custom-config
HTTP methodPATCH
Frequency600/minute

Header parameters

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

See Obtain access token.

Query parameters

ParameterExample valueRequiredTypeDescription
config_type1YesIntegerThe type of the configuration. Valid values:
  • 1: the BE/Compute Node configuration.
  • 4: the FE/Coordinator Node configurations.
warehouse_id5f11b567-da24-4481-b778-c2d00e13090eNoStringThe ID of the warehouse for which you want to configure static Compute Node parameters in your elastic cluster. You do not need to specify this parameter if you want to configure static BE/FE parameters in a classic cluster or Coordinator Node parameters in an elastic cluster.

Response

Sample response

{
"code": 20000,
"data": {}
}

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. This field is always empty.