본문으로 건너뛰기

파라미터

파라미터 그룹 생성

디폴트 파라미터 그룹을 기반으로 새로운 파라미터 그룹을 생성합니다.

Request
파라미터 그룹 생성 Request Syntax
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/parameter-groups" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'
종류파라미터유형설명
Header{token-id}*StringAPI 인증 토큰 참고
BodyparameterGroupId*String 기반이 될 파라미터 그룹 ID
name*String새로운 파라미터 그룹 이름
descriptionString새로운 파라미터 그룹 설명
파라미터 그룹 생성 Request Body Example
{
"parameterGroupId": "qwerqwer-7347-4d87-a49f-e705e91db2fb",
"name": "test-parameter-group",
"description": "test parameter group"
}
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
objectIdString파라미터 그룹 ID
파라미터 그룹 생성 Response Example
201 Created
content-length: 52
content-type: application/json; charset=UTF-8

{
"objectId": "12341234-1234-1234-1234-e705e91db2fb"
}

파라미터 그룹 목록 조회

파라미터 그룹 목록을 조회합니다. 쿼리 파라미터로 engineVersion={engine-version} 을 전달할 경우 해당 엔진 버전에 해당하는 파라미터 그룹을 조회할 수 있고, 쿼리 파라미터로 parameterGroupType={parameter-group-type} 을 전달할 경우 기본 또는 커스텀 파라미터 그룹을 조회할 수 있습니다.

Request
파라미터 그룹 목록 조회 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}"
종류파라미터유형설명
Header{token-id}*StringAPI 인증 토큰 참고
Query{engine-version}String엔진 버전을 지정
Query{parameter-group-type}String파라미터 그룹 유형을 지정
- default, custom
Query{clusterMode}String허용값
- enabled, disabled
- 비어있거나 없으면 둘 다 선택
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
parameterGroups[]Object Array파라미터 그룹 목록
parameterGroups[].idString파라미터 그룹 ID
parameterGroups[].engineVersionString파라미터 그룹의 Redis 엔진 버전
parameterGroups[].nameString파라미터 그룹 이름
parameterGroups[].descriptionString파라미터 그룹 설명
parameterGroups[].isDefaultBoolean기본 파라미터 그룹 여부
parameterGroups[].defaultParameterGroupIdString커스텀 파라미터 그룹이 참조하고 있는 기본 파라미터 그룹의 ID
- 기본 파라미터 그룹이라면 해당 값은 빈 값
parameterGroups[].rollbackAvailableBoolean해당 파라미터 그룹의 파라미터 롤백 가능 여부
parameterGroups[].clusterModeEnabledBoolean해당 파라미터 그룹의 클러스터 모드 사용 여부
parameterGroups[].existErrorSyncBoolean해당 파라미터 그룹을 사용하는 클러스터 중 싱크 실패한 클러스터의 존재 여부
parameterGroups[].clusterSizeInteger해당 파라미터 그룹을 사용하는 클러스터 수
parameterGroups[].createdAtString해당 파라미터 그룹을 생성한 날짜
파라미터 그룹 목록 조회 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
}
]
}

파라미터 그룹 상세 정보 조회

지정한 파라미터 그룹의 상세 정보를 조회합니다. 

Request
파라미터 그룹 상세 정보 조회 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}*StringAPI 인증 토큰 참고
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
idString파라미터 그룹 ID
nameString파라미터 그룹 이름
descriptionString파라미터 그룹 설명
engineVersionString파라미터 그룹의 Redis 엔진 버전
isDefaultBoolean기본 파라미터 그룹 여부
defaultParameterGroupIdString기본 파라미터 그룹 ID
clusterModeEnabledBoolean해당 파라미터 그룹의 클러스터 모드 사용 여부
existErrorSyncBoolean해당 파라미터 그룹을 사용하는 클러스터 중 싱크 실패한 클러스터의 존재 여부
clusterSizeInteger해당 파라미터 그룹을 사용하는 클러스터 수
rollbackAvailableBoolean해당 파라미터 그룹의 파라미터 롤백 가능 여부
parameters[]Object Array파라미터 목록
parameters[].parameterTypeString파라미터 유형
- STATIC, DYNAMIC 등
parameters[].parameterKeyString파라미터 키
parameters[].parameterValueString파라미터 값
parameters[].defaultParameterValueString파라미터 기본값
parameters[].dataTypeString파라미터 값의 데이터 유형
- ENUM, STRING, INTEGER
parameters[].editableBoolean파라미터 값의 수정 가능 여부
- STRING: 정규표현식
- NUMBER: 숫자 범위로 표현, 여러 값이 들어갈 경우 | 기호로 구분
ex) 5|10|11~100
- ENUM: | 기호로 구분
ex) string|string|string
parameters[].validationValueFormatString파라미터 값에 대한 유효성
createdAtString파라미터 그룹을 생성한 날짜
백업 상세 정보 조회 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
}

파라미터 그룹 삭제

파라미터 그룹을 삭제합니다. 지정한 파라미터 그룹을 사용하는 클러스터가 없어야 합니다.

Request
파라미터 그룹 삭제 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}"
종류파라미터유형설명
URL{parameter-group-id or parameter-group-name}*String파라미터 그룹의 ID 또는 이름
Header{token-id}*StringAPI 인증 토큰 참고
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
objectIdString파라미터 그룹 ID
파라미터 그룹 삭제 Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
"objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

파라미터 수정

파라미터 그룹의 파라미터 값을 수정합니다.

Request
파라미터 그룹 수정 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}'
종류파라미터유형설명
URL{parameter-group-id or parameter-group-name}*String파라미터 그룹의 ID 또는 이름
Header{token-id}*StringAPI 인증 토큰 참고
BodydescriptionString파라미터 그룹 설명
parameters[]Object Array변경할 파라미터 목록
parameters[].parameterKeyString변경할 파라미터 키
parameters[].parameterValueString변경할 파라미터 값
applyModeString연결된 클러스터들에 일괄 반영할지 순차적으로 반영할지 선택
- 파라미터를 수정할 경우에만 선택
• 순차: sequential
• 일괄: parallel
파라미터 그룹 수정 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
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
objectIdString파라미터 그룹 ID
파라미터 그룹 삭제 Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
"objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

파라미터 그룹 롤백

파라미터 그룹의 파라미터 값을 바로 이전에 사용하던 값으로 되돌립니다.

Request
파라미터 그룹 롤백 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}"
종류파라미터유형설명
URL{parameter-group-id or parameter-group-name}*String파라미터 그룹의 ID 또는 이름
Header{token-id}*StringAPI 인증 토큰 참고
파라미터 그룹 롤백 Request Body Example
{
"applyMode": "sequential"
}
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
objectIdString파라미터 그룹 ID
파라미터 그룹 롤백 Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
"objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

파라미터 그룹 전체 초기화

파라미터 그룹의 파라미터를 기본 파라미터 그룹의 파라미터 값으로 변경합니다.

Request
파라미터 그룹 초기화 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}'
종류파라미터유형설명
URL{parameter-group-id or parameter-group-name}*String파라미터 그룹의 ID 또는 이름
Header{token-id}*StringAPI 인증 토큰 참고
BodyapplyMode*String연결된 클러스터들에 일괄 반영할지 순차적으로 반영할지 선택
순차: sequential
일괄: parallel
파라미터 그룹 초기화 Request Body Example
{
"applyMode": "sequential"
}
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
objectIdString파라미터 그룹 ID
파라미터 그룹 초기화 Response Example
200 OK
content-length: ...
content-type: application/json; charset=UTF-8

{
"objectId": "qwerqwer-7347-4d87-a49f-e705e91db2fb"
}

파라미터 그룹 최신 이벤트 조회

파라미터 그룹에 관련된 최근 7일간의 이벤트를 조회합니다.

Request
파라미터 그룹 최신 이벤트 조회 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}"
종류파라미터유형설명
URL{parameter-group-id or parameter-group-name}*String파라미터 그룹의 ID 또는 이름
Header{token-id}*StringAPI 인증 토큰 참고
Response
상태 코드설명
200리소스 조회/삭제 요청에 대한 성공 응답
400사용자의 요청이 유효하지 않아 작업을 진행할 수 없음
401인증되지 않은 사용자가 요청한 경우
403권한이 없는 사용자가 요청한 경우
404사용자가 요청한 리소스가 존재하지 않은 경우
500내부 에러로 작업을 진행할 수 없는 경우
필드유형설명
events[]Object Array이벤트 목록
events[].eventNameString이벤트 이름
events[].messageString이벤트 내용
events[].createdAtString생성 날짜 (RFC3339)
파라미터 그룹 최신 이벤트 조회 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",
}
]
}