Parameter

Create parameter group

Create a new parameter group based on the default parameter group.

Request

Create parameter group request syntax
{
  "parameterGroupId": "qwerqwer-7347-4d87-a49f-e705e91db2fb",
  "name": "test-parameter-group",
  "description": "test parameter group"
}

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
objectId	String	Parameter group ID

Create parameter group request Response Example
201 Created
content-length: 52
content-type: application/json; charset=UTF-8
 
{
  "objectId": "12341234-1234-1234-1234-e705e91db2fb"
}

Retrieve parameter group list

Retrieve list of parameter groups. If query parameter engineVersion={engine-version} is provided, parameter groups for the specified engine version will be returned. If query parameter parameterGroupType={parameter-group-type} is provided, default or custom parameter groups will be filtered accordingly.

Request

Retrieve parameter group list request syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups?engineVersion={engine-version}&parameterGroupType={parameter-group-type}&clusterMode={clusterMode}" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Type	Description
Header	`{token-id}`*	String	Refer to Get API authentication token
Query	`{engine-version}`	String	Specify engine version
Query	`{parameter-group-type}`	String	Specify parameter group type - default, custom
Query	`{clusterMode}`	String	Allowed values - enabled, disabled - If empty or omitted, both are selected

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
parameterGroups[]	Object array	List of parameter groups
parameterGroups[].id	String	Parameter group ID
parameterGroups[].engineVersion	String	Redis engine version of parameter group
parameterGroups[].name	String	Name of parameter group
parameterGroups[].description	String	Description of parameter group
parameterGroups[].isDefault	Boolean	Whether group is default parameter group
parameterGroups[].defaultParameterGroupId	String	ID of base parameter group referenced by custom group - Empty if default group
parameterGroups[].rollbackAvailable	Boolean	Whether rollback is available for parameters in this group
parameterGroups[].clusterModeEnabled	Boolean	Whether cluster mode is enabled for this group
parameterGroups[].existErrorSync	Boolean	Whether any clusters using this group have failed sync
parameterGroups[].clusterSize	Integer	Number of clusters using this group
parameterGroups[].createdAt	String	Creation date of this parameter group

Retrieve parameter group list Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "parameterGroups": [
    {
      "id": "12341234-1234-1234-a49f-e705e91db2fb",
      "engineVersion": "5.0.6",
      "name": "test-parameter-group-1",
      "description": "test param group 1",
      "isDefault": false,
      "defaultParameterGroupId": "12341234-1234-1234-1234-e705e91db2fb",
      "rollbackAvailable": false,
      "clusterModeEnabled": true,
      "existErrorSync": false,
      "clusterSize": 5,
      "createdAt": "2024-03-06T02:35:13Z"
    },
    {
      "id": "56785678-5678-5678-a49f-e705e91db2fb",
      "engineVersion": "6.2.5",
      "name": "test-parameter-group-2",
      "description": "test param group 2",
      "isDefault": false,
      "defaultParameterGroupId": "56785678-5678-5678-5678-e705e91db2fb",
      "rollbackAvailable": true,
      "clusterModeEnabled": true,
      "existErrorSync": true,
      "clusterSize": 3,
      "createdAt": "2024-03-06T02:35:13Z"
    }
  ]
}

Retrieve parameter group details

Retrieve detailed information of a specified parameter group.

Request

Retrieve parameter group details request syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}" \
-H "X-Auth-Token: {token-id}"

종류	파라미터	유형	설명
URL	`{parameter-group-id or parameter-group-name}`*	String	파라미터 그룹의 ID 또는 이름
Header	`{token-id}`*	String	API 인증 토큰 참고

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
id	String	Parameter group ID
name	String	Name of parameter group
description	String	Description of parameter group
engineVersion	String	Redis engine version of parameter group
isDefault	Boolean	Whether group is default parameter group
defaultParameterGroupId	String	ID of base parameter group
clusterModeEnabled	Boolean	Whether cluster mode is enabled for this group
existErrorSync	Boolean	Whether any clusters using this group have failed sync
clusterSize	Integer	Number of clusters using this group
rollbackAvailable	Boolean	Whether rollback is available for parameters in this group
parameters[]	Object array	List of parameters
parameters[].parameterType	String	Type of parameter - STATIC, DYNAMIC, etc.
parameters[].parameterKey	String	Parameter key
parameters[].parameterValue	String	Parameter value
parameters[].defaultParameterValue	String	Default value of parameter
parameters[].dataType	String	Data type of parameter value - ENUM, STRING, INTEGER
parameters[].editable	Boolean	Whether parameter value is editable - STRING: Regular expression - NUMBER: Expressed as number range, use `\|` to separate multiple values e.g., `5\|10\|11~100` - ENUM: Separated by `\|` e.g., `string\|string\|string`
parameters[].validationValueFormat	String	Validation format for parameter value
createdAt	String	Creation date of parameter group

Retrieve parameter group details Response Example
200 Created
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "id": "12341234-1234-1234-a49f-e705e91db2fb",
  "name": "test-parameter-group",
  "description": "test description",
  "engineVersion": "6.2.5",
  "isDefault": false,
  "defaultParameterGroupId": "qwerqwer-7347-4d87-a49f-e705e91db2fb",
  "clusterModeEnabled": false,
  "existErrorSync": false,
  "clusterSize": 5,
  "parameters": [
    {
      "parameterType": "DYNAMIC",
      "parameterKey": "param-key1",
      "parameterValue": "param-val1",
      "defaultParameterValue": "init-param-val1",
      "dataType": "STRING",
      "editable": true,
      "validationValueFormat": "param-val1|param-val2|param-val3",
    },
    {
      "parameterType": "DYNAMIC",
      "parameterKey": "param-key2",
      "parameterValue": "1",
      "defaultParameterValue": "0",
      "dataType": "NUMBER",
      "editable": true,
      "validationValueFormat": "0~10",
    }
  ],
  "rollbackAvailable": false,
  "createdAt": "2024-03-06T02:35:13Z"
}

Delete parameter group

Delete a parameter group. The specified parameter group must not be used by any clusters.

Request

Delete parameter group request syntax
curl -X DELETE "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	ID or name of parameter group
Header	`{token-id}`*	String	Refer to Get API authentication token

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
objectId	String	Parameter group ID

Delete parameter group Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
} 

Modify parameters

Modify parameter values in a parameter group.

Request

Modify parameters request syntax
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'

Type	Parameter	Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	ID or name of parameter group
Header	`{token-id}`*	String	Refer to Get API authentication token
Body	description	String	Description of parameter group
	parameters[]	Object array	List of parameters to be modified
	parameters[].parameterKey	String	Parameter key to modify
	parameters[].parameterValue	String	New value for the parameter
	applyMode	String	Choose whether to apply changes to connected clusters in parallel or sequentially - Only required when modifying parameters • Sequential: `sequential` • Parallel: `parallel`

Modify parameters Request Body Example
{
  "description": "test description",
  "parameters: [
    {
      "parameterKey": "param-key1",
      "parameterValue": "param-val1",
    },
    {
      "parameterKey": "param-key2"
      "parameterValue": "param-val2",
    },
    {
      "parameterKey": "param-key3",
      "parameterValue": "param-val3",
    } 
  ],
  "applyMode": "sequential"
}

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
objectId	String	Parameter group ID

Modify parameters response example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
} 

Roll back parameter group

Roll back parameter values in a parameter group to their previously used values.

Request

Roll back parameter group request syntax
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}/rollback" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	ID or name of parameter group
Header	`{token-id}`*	String	Refer to Get API authentication token

Roll back parameter group  Request Body Example
{
  "applyMode": "sequential"
}

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
objectId	String	Parameter group ID

Roll back parameter group Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
} 

Reset parameter group

Reset parameter values in a parameter group to those of the default parameter group.

Request

Reset parameter group request syntax
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}/reset" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'

Type	Parameter	Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	ID or name of parameter group
Header	`{token-id}`*	String	Refer to Get API authentication token
Body	applyMode*	String	Choose whether to apply changes to connected clusters in parallel or sequentially • Sequential: `sequential` • Parallel: `parallel`

Reset parameter group Request Body Example
{
  "applyMode": "sequential"
}

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
objectId	String	Parameter group ID

Reset parameter group response example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
} 

Retrieve recent parameter group events

Retrieve events related to a parameter group from the past 7 days.

Request

Retrieve recent parameter group events request syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups/{parameter-group-id or parameter-group-name}/events" \
-H "X-Auth-Token: {token-id}"

Type	Parameter	Type	Description
URL	`{parameter-group-id or parameter-group-name}`*	String	ID or name of parameter group
Header	`{token-id}`*	String	Refer to Get API authentication token

Response

Status code	Description
`200`	Successful response to resource query or delete request
`400`	Request is invalid and cannot be processed
`401`	Request made by unauthenticated user
`403`	Request made by unauthorized user
`404`	Requested resource does not exist
`500`	Operation cannot proceed due to internal error

Field	Type	Description
events[]	Object array	List of events
events[].eventName	String	Name of event
events[].message	String	Description of event
events[].createdAt	String	Creation date (RFC3339 format)

Retrieve recent parameter group events response example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
 
{
  "events": [
    {
      "eventName": "Apply Parameter",
      "message": "",
      "createdAt": "2024-05-07T12:00:01.123456Z",
    },
    {
      "eventName": "Update Parameter",
      "message": "",
      "createdAt": "2024-05-07T12:00:00.000000Z",
    }
  ]
}

Create parameter group​

Request​

Response​

Retrieve parameter group list​

Request​

Response​

Retrieve parameter group details​

Request​

Response​

Delete parameter group​

Request​

Response​

Modify parameters​

Request​

Response​

Roll back parameter group​

Request​

Response​

Reset parameter group​

Request​

Response​

Retrieve recent parameter group events​

Request​

Response​

Create parameter group

Request

Response

Retrieve parameter group list

Request

Response

Retrieve parameter group details

Request

Response

Delete parameter group

Request

Response

Modify parameters

Request

Response

Roll back parameter group

Request

Response

Reset parameter group

Request

Response

Retrieve recent parameter group events

Request

Response