When cluster mode disabled
The following APIs can be used when cluster mode is set to disabled.
- The value for the
user.password
field must be encrypted for successful creation.
Create instance set
Create new instance set
Create a new instance set.
Request
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets" \
-H "X-Auth-Token: {token-id}" \
-H "Content-Type: application/json" \
-d '{Body}'
Type | Parameter | Data Type | Description |
---|---|---|---|
Header | {token-id} * | String | Refer to API authentication token |
Content-Type* | String | Default content type: application/json | |
Body | description | String | Instance set description - Max 100 characters - Emojis not allowed - Line breaks (CR, LF) not allowed |
replicas* | Integer | Number of nodes - Total number of nodes, including Primary and Replica | |
flavorId* | String | Flavor ID | |
instanceSetName* | String | Instance set name - 4 to 20 characters - Only lowercase letters, numbers, and - allowed - - cannot be used consecutively - Must start with a letter - Must end with a letter or number - No spaces allowed | |
recoveryEnabled* | Boolean | High Availability mode - true : Enabled - false : Disabled | |
subnets[]* | Object Array | List of subnets available for placement | |
subnets[].id* | String | Subnet ID - Subnet ID can be found in Console > VPC > Subnet | |
subnetAssignments[]* | Object Array | Subnet assignments - Only subnets from the subnets field can be used | |
subnetAssignments[].primary* | Object | Subnet assigned as Primary | |
subnetAssignments[].primary.id* | String | Primary subnet ID | |
subnetAssignments[].replicas[]* | Object Array | List of subnets assigned to Replica | |
subnetAssignments[].replicas[].id* | String | Replica subnet ID | |
securityGroups[]* | Object Array | List of security groups connected to the instance set | |
securityGroups[].id* | String | Security group ID - Found in Console > VPC > Security Group | |
backupSchedule | Object | Automatic backup policy - If not specified, automatic backup is disabled | |
backupSchedule.cron | String | Cron expression for backup schedule - Only time settings allowed - Use a 5-field cron expression (e.g., "* 1 * * *" for daily backup at 1 AM KST) - Time field accepts values between 0-23 (no special characters allowed) - All other fields must use an asterisk ( * ) | |
backupSchedule.retentionLimit | Integer | Backup retention period (in days) - Minimum 1 day, maximum 35 days | |
port* | Integer | Redis port number - Currently, only 6379 is allowed | |
projectId* | String | Project ID | |
version* | String | Redis version - Supported versions: 5.0.6 , 6.2.5 for non-cluster mode | |
user | Object | Database user information - Account details for database access | |
user.name | String | Database user name | |
user.password | String | Database user password (encrypted or hashed) How to encrypt the database user password | |
parameterGroupId* | String | Parameter group ID applied to the instance set |
{
"description": "mars-test-description",
"replicas": 3,
"flavorId": "3830ebad-ea2f-4822-8a7d-9e301c86a58d",
"instanceSetName": "mars-repl-test",
"recoveryEnabled": true,
"subnets": [
{"id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b"},
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"}
],
"subnetAssignments": [
{
"primary": {"id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b"},
"replicas": [
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"},
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"}
]
}
],
"securityGroups": [
{"id": "abcdxxxx-4870-4c4e-a267-2de13e38c2ea"},
{"id": "qwergggg-4870-4c4e-a267-2de13e38c2ea"}
],
"backupSchedule": {
"cron": "* 1 * * *",
"retentionLimit": 30
},
"parameterGroupId": "bbbbcccc-1234-1234-5678-e705e91db2fb",
"port": 6379,
"projectId": "8eebb8f91c0a465096316820a21a9772",
"version": "6.2.5"
}
Response
Status Code | Description |
---|---|
201 | Successful response to resource creation request |
400 | Invalid request, unable to process |
401 | Unauthorized user request |
422 | Request syntax is valid, but unable to process the request |
403 | User does not have the required permissions |
409 | Duplicate request due to the current server state |
500 | Internal server error, unable to process the request |
Field | Data Type | Description |
---|---|---|
objectId | String | Instance set ID |
201 Created
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "xxxxxxxx-7347-4d87-a49f-e705e91db2fb"
}
Create instance set from existing backup (restore)
Restore an instance set from an existing backup.
When restoring from an existing backup, if the Redis memory size at the time of backup exceeds 60% of the memory of the flavor being restored, the instance set creation (restore) request may fail.
Request
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets" \
-H "X-Auth-Token: {token-id}" \
-H "Content-Type: application/json" \
-d '{Body}'
Type | Parameter | Data Type | Description |
---|---|---|---|
Header | {token-id} * | String | Refer to API authentication token |
Content-Type* | String | Default content type: application/json | |
Body | description | String | Instance set description - Max 100 characters - Emojis not allowed - Line breaks (CR, LF) not allowed |
replicas* | Integer | Number of nodes - Total number of nodes, including Primary and Replica | |
flavorId* | String | Flavor ID | |
instanceSetName* | String | Instance set name - 4 to 20 characters - Only lowercase letters, numbers, and - allowed - - cannot be used consecutively - Must start with a letter - Must end with a letter or number - No spaces allowed | |
recoveryEnabled* | Boolean | High Availability mode - true : Enabled - false : Disabled | |
subnets[]* | Object Array | List of subnets available for placement | |
subnets[].id* | String | Subnet ID - Subnet ID can be found in Console > VPC > Subnet | |
subnetAssignments[]* | Object Array | Subnet assignments - Only subnets from the subnets field can be used | |
subnetAssignments[].primary* | Object | Subnet assigned as Primary | |
subnetAssignments[].primary.id* | String | Primary subnet ID | |
subnetAssignments[].replicas[]* | Object Array | List of subnets assigned to Replica | |
subnetAssignments[].replicas[].id* | String | Replica subnet ID | |
securityGroups[]* | Object Array | List of security groups connected to the instance set | |
securityGroups[].id* | String | Security group ID - Found in Console > VPC > Security Group | |
restoreSource | Object | Restore source information | |
restoreSource.backupName | String | A name from the MemStore backup list | |
backupSchedule | Object | Automatic backup policy - If not specified, automatic backup is disabled | |
backupSchedule.cron | String | Cron expression for backup schedule - Only time settings allowed - Use a 5-field cron expression (e.g., "* 1 * * *" for daily backup at 1 AM KST) - Time field accepts values between 0-23 (no special characters allowed) - All other fields must use an asterisk ( * ) | |
backupSchedule.retentionLimit | Integer | Backup retention period (in days) - Minimum 1 day, maximum 35 days | |
port* | Integer | Redis port number - Currently, only 6379 is allowed | |
projectId* | String | Project ID | |
version* | String | Redis version - Supported versions: 5.0.6 , 6.2.5 for non-cluster mode | |
user | Object | Database user information - Account details for database access | |
user.name | String | Database user name | |
user.password | String | Database user password (encrypted or hashed) How to encrypt the database user password | |
parameterGroupId* | String | Parameter group ID applied to the instance set |
{
"description": "mars-test-description",
"replicas": 3,
"flavorId": "3830ebad-ea2f-4822-8a7d-9e301c86a58d",
"instanceSetName": "mars-repl-test",
"recoveryEnabled": true,
"subnets": [
{"id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b"},
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"}
],
"subnetAssignments": [
{
"primary": {"id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b"},
"replicas": [
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"},
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"}
]
}
],
"securityGroups": [
{"id": "abcdxxxx-4870-4c4e-a267-2de13e38c2ea"},
{"id": "qwergggg-4870-4c4e-a267-2de13e38c2ea"}
],
"restoreSource": {
"backupName": "scheduled.testhen.2024-02-27-16-47.KST"
},
"backupSchedule": {
"cron": "* 1 * * *",
"retentionLimit": 30
},
"parameterGroupId": "bbbbcccc-1234-1234-5678-e705e91db2fb",
"port": 6379,
"projectId": "8eebb8f91c0a465096316820a21a9772",
"version": "6.2.5"
}
Response
Status Code | Description |
---|---|
201 | Successful response to resource creation request |
400 | Invalid request, unable to process |
401 | Unauthorized user request |
403 | User does not have the required permissions |
409 | Duplicate request due to the current server state |
500 | Internal server error, unable to process the request |
Field | Data Type | Description |
---|---|---|
objectId | String | Instance set ID |
201 Created
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "xxxxxxxx-7347-4d87-a49f-e705e91db2fb"
}
Create instance set from Object Storage file (restore)
Restore an instance set using a file stored in Object Storage.
If the API authentication token expires while retrieving the backup file from Object Storage, the instance set restore may fail. Additionally, if the Redis memory size in the backup file exceeds 60% of the memory of the flavor being restored, the instance set may not be successfully created (restored).
Request
curl -X POST "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets" \
-H "X-Auth-Token: {token-id}" \
-H "Content-Type: application/json" \
-d '{Body}'
Type | Parameter | Data Type | Description |
---|---|---|---|
Header | {token-id} * | String | Refer to API authentication token |
Content-Type* | String | Default content type: application/json | |
Body | description | String | Instance set description - Max 100 characters - Emojis not allowed - Line breaks (CR, LF) not allowed |
replicas* | Integer | Number of nodes - Total number of nodes, including Primary and Replica | |
flavorId* | String | Flavor ID | |
instanceSetName* | String | Instance set name - 4 to 20 characters - Only lowercase letters, numbers, and - allowed - - cannot be used consecutively - Must start with a letter - Must end with a letter or number - No spaces allowed | |
recoveryEnabled* | Boolean | High Availability mode - true : Enabled - false : Disabled | |
subnets[]* | Object Array | List of subnets available for placement | |
subnets[].id* | String | Subnet ID - Subnet ID can be found in Console > VPC > Subnet | |
subnetAssignments[]* | Object Array | Subnet assignments - Only subnets from the subnets field can be used | |
subnetAssignments[].primary* | Object | Subnet assigned as Primary | |
subnetAssignments[].primary.id* | String | Primary subnet ID | |
subnetAssignments[].replicas[]* | Object Array | List of subnets assigned to Replica | |
subnetAssignments[].replicas[].id* | String | Replica subnet ID | |
securityGroups[]* | Object Array | List of security groups connected to the instance set | |
securityGroups[].id* | String | Security group ID - Found in Console > VPC > Security Group | |
restoreSource | Object | Restore source information | |
restoreSource.files[] | String Array | Object Storage path for the user backup file - Must be within the same region and project with edit permissions - Format: bucket/folder/.../file - Restoration may fail if the backup file uses Redis version 7 or higher | |
backupSchedule | Object | Automatic backup policy - If not specified, automatic backup is disabled | |
backupSchedule.cron | String | Cron expression for backup schedule - Only time settings allowed - Use a 5-field cron expression (e.g., "* 1 * * *" for daily backup at 1 AM KST) - Time field accepts values between 0-23 (no special characters allowed) - All other fields must use an asterisk ( * ) | |
backupSchedule.retentionLimit | Integer | Backup retention period (in days) - Minimum 1 day, maximum 35 days | |
port* | Integer | Redis port number - Currently, only 6379 is allowed | |
projectId* | String | Project ID | |
version* | String | Redis version - Supported versions: 5.0.6 , 6.2.5 for non-cluster mode | |
user | Object | Database user information - Account details for database access | |
user.name | String | Database user name | |
user.password | String | Database user password (encrypted or hashed) How to encrypt the database user password | |
parameterGroupId* | String | Parameter group ID applied to the instance set |
{
"description": "mars-test-description",
"replicas": 3,
"flavorId": "3830ebad-ea2f-4822-8a7d-9e301c86a58d",
"instanceSetName": "mars-repl-test",
"recoveryEnabled": true,
"subnets": [
{"id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b"},
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"}
],
"subnetAssignments": [
{
"primary": {"id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b"},
"replicas": [
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"},
{"id": "yyyyyyyy-0a69-4f8b-b56d-59ce12b4d55b"}
]
}
],
"securityGroups": [
{"id": "abcdxxxx-4870-4c4e-a267-2de13e38c2ea"},
{"id": "qwergggg-4870-4c4e-a267-2de13e38c2ea"}
],
"restoreSource": {
"files": ["bucket/path-to-file"]
},
"backupSchedule": {
"cron": "* 1 * * *",
"retentionLimit": 30
},
"parameterGroupId": "bbbbcccc-1234-1234-5678-e705e91db2fb",
"port": 6379,
"projectId": "8eebb8f91c0a465096316820a21a9772",
"version": "6.2.5"
}
Response
Status Code | Description |
---|---|
201 | Successful response to resource creation request |
400 | The user's request is invalid, unable to process |
401 | Request made by an unauthorized user |
403 | Request made by a user without permission |
409 | A duplicate request occurred due to the current server state |
500 | Internal error, unable to process the request |
Field | Type | Description |
---|---|---|
objectId | String | Instance set ID |
201 Created
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "xxxxxxxx-7347-4d87-a49f-e705e91db2fb"
}
Delete instance set
Deletes an instance set. If the instance set has automatic backups, deletion may not be possible via the console. In such cases, you can include the keepAutomaticBackups
parameter in the API request to allow deletion.
Request
curl -X DELETE "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}?keepAutomaticBackups={keep-auto-backup}" \
-H "X-Auth-Token: {token-id}" \
Type | Parameter | Data Type | Description |
---|---|---|---|
Header | {token-id} * | String | Refer to API authentication token |
URL | {instance-set-id} * | String | Instance set ID |
Query | {keep-auto-backup} | Boolean | Whether to retain automatic backups - Required if automatic backups exist - true : Retains automatic backups for 7 days (Note: backups scheduled for earlier deletion will be retained as is) - false : Deletes automatic backups along with the instance set |
Response
Status Code | Description |
---|---|
200 | Successful response to resource retrieval/deletion request |
400 | Invalid request, unable to process |
401 | Request made by an unauthorized user |
403 | Request made by a user without permission |
404 | The requested resource does not exist |
500 | Internal error, unable to process the request |
Field | Data Type | Description |
---|---|---|
objectId | String | Instance set ID |
200 OK
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "aabbccdd-a1d4-465b-8009-1d272bcc2db7"
}
Update instance set
Updates the automatic backup policy and the associated parameter group of an instance set.
Request
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'
Type | Parameter | Data Type | Description |
---|---|---|---|
Header | {token-id} * | String | Refer to API authentication token |
URL | {instance-set-id} * | String | Instance set ID |
Body | backupSchedule | Object | Backup schedule settings |
backupSchedule.cron | String | Cron expression for backup schedule - Only time can be set - Uses a 5-field cron expression - Passing an empty string ( "" ) will delete the backup | |
backupSchedule.retentionLimit | Integer | Retention period for backups (in days) | |
description | String | Instance set description | |
parameterGroupId | String | ID of the parameter group to be linked to the instance set - Cannot modify parameterGroupId to an empty value |
Response
Status Code | Description |
---|---|
200 | Successful response to resource retrieval/deletion request |
400 | Invalid request, unable to process |
401 | Request made by an unauthorized user |
403 | Request made by a user without permission |
404 | The requested resource does not exist |
500 | Internal error, unable to process the request |
Field | Data Type | Description |
---|---|---|
objectId | String | Instance set ID |
200 OK
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "aabbccdd-a1d4-465b-8009-1d272bcc2db7"
}
Update backup policy/description
Modifies the automatic backup policy or description of an instance set.
Request
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'
Type | Parameter | Data Type | Description |
---|---|---|---|
URL | {instance-set-id} * | String | Instance set ID |
Header | {token-id} * | String | Refer to API authentication token |
Body | backupSchedule | Object | Backup schedule settings |
backupSchedule.cron | String | Cron expression for backup schedule - Passing an empty string ( "" ) will delete the configured automatic backup policy regardless of retentionLimit - Only time can be set - Uses a 5-field cron expression (e.g., "* 1 * * " → automatic backup created daily at 1 AM (KST)) - The hour field must be between 0-23 (no special characters allowed) - Other fields must use asterisks ( * ) | |
backupSchedule.retentionLimit | Integer | Retention period for backups (in days) - Minimum 1 day, maximum 35 days | |
description | String | Description |
{
"backupSchedule": {
"cron": "* 3 * * *",
"retentionLimit": 15
},
"description": ""
}
Response
Status Code | Description |
---|---|
200 | Successful response to the resource update request |
400 | Invalid request, unable to process |
401 | Request made by an unauthorized user |
403 | Request made by a user without permission |
404 | The requested resource does not exist |
500 | Internal error, unable to process the request |
Field | Data Type | Description |
---|---|---|
objectId | String | Instance set ID |
200 OK
content-length: ...
content-type: application/json; charset=UTF-8
{
"objectId": "ffddssaa-7347-4d87-a49f-e705e91db2fb"
}
Get instance list of instance set
Retrieves the list of instances (nodes) in an instance set.
Request
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}/instances" \
-H "X-Auth-Token: {token-id}" \
Type | Parameter | Data Type | Description |
---|---|---|---|
URL | {instance-set-id} * | String | Instance set ID |
Header | {token-id} * | String | Refer to API authentication token |
Response
Status Code | Description |
---|---|
200 | Successful response to resource retrieval/deletion request |
400 | Invalid request, unable to process |
401 | Request made by an unauthorized user |
403 | Request made by a user without permission |
500 | Internal error, unable to process the request |
Field | Data Type | Description |
---|---|---|
size | Integer | Number of records |
data[] | Object Array | List of instances |
data[].instanceName | String | Instance name |
data[].description | String | Instance set description |
data[].projectId | String | Project ID |
data[].role | String | Instance role (primary/replica) |
data[].flavorId | String | Flavor ID |
data[].version | String | Redis version |
data[].port | Integer | Redis port number |
data[].subnet | Object | Subnet information |
data[].subnet.id | String | Subnet ID |
data[].creator | String | Instance set creator |
data[].objectId | String | Instance ID |
data[].endpoint | String | Instance endpoint (private IP) |
data[].license | String | License |
data[].createdAt | Integer | Creation time (RFC3339) |
data[].status | String | Instance status (e.g., PROVISIONING/FAILED) |
200 OK
content-type: application/json; charset=UTF-8
{
"size": 2,
"data": [
{
"instanceName": "test-instance-set-1",
"description": "test",
"projectId": "abcdabcdf4d14b41a36823e2091c3a6d",
"flavorId": "xxxxxxxx-ea2f-4822-8a7d-9e301c86a58d",
"version": "6.2.5",
"port": 6379,
"subnet": {
"id": "qqqqwwww-2726-432e-aa37-04b778ef2ba1"
},
"creator": "ms@kakaoenterprise.com",
"objectId": "abcdefg-a97a-59c8-9e6a-e967383c65e2",
"role": "primary",
"endpoint": "172.30.1.244",
"license": "GPL",
"createdAt": "2024-03-11T01:15:03Z",
"status": "Running"
},
{
"instanceName": "test-instance-set-2",
"description": "test",
"projectId": "abcdabcdf4d14b41a36823e2091c3a6d",
"flavorId": "xxxxxxxx-ea2f-4822-8a7d-9e301c86a58d",
"version": "6.2.5",
"port": 6379,
"subnet": {
"id": "qqqqwwww-2726-432e-aa37-04b778ef2ba1"
},
"creator": "ms@kakaoenterprise.com",
"objectId": "abcdefg-39c8-55c2-b4d3-9009c554d102",
"role": "replica",
"endpoint": "172.30.0.67",
"license": "GPL",
"createdAt": "2024-03-11T01:15:03Z",
"status": "Running"
}
]
}
Delete instance from instance set
Deletes an instance (node) from an instance set.
- If high availability mode is enabled, the primary instance cannot be deleted.
- If high availability mode is enabled, only instances in a "Running" state can be deleted.
- If high availability mode is disabled, the primary instance can only be deleted if it is in a "Failed" state.
- If the instance set has an automatic backup policy and contains only 2 nodes, node deletion is not allowed.
Request
curl -X DELETE "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}/instances/{instance-id}" \
-H "X-Auth-Token: {token-id}" \
Type | Parameter | Data type | Description |
---|---|---|---|
URL | {instance-set-id} * | String | ID of the instance set |
{instance-id} * | String | ID of the instance | |
Header | {token-id} * | String | Refer to API authentication token |
Response
Status code | Description |
---|---|
200 | Successful response for resource retrieval/deletion request |
400 | Invalid request, cannot proceed |
401 | Request made by unauthorized user |
403 | Request made by user without proper permissions |
404 | Requested resource not found |
500 | Internal error, unable to complete the request |
Field | Data type | Description |
---|---|---|
objectId | String | ID of the instance set |
200 OK
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "aaaabbbb-a1d4-465b-8009-1d272bcc2db7"
}
Promote replica to primary
Promote a specific replica to primary. Promotion requests can only be made when high availability mode is disabled.
Request
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}/primary" \
-H "X-Auth-Token: {token-id}" \
-H "Content-Type: application/json" \
-d '{Body}'
Type | Parameter | Data type | Description |
---|---|---|---|
URL | {instance-set-id} * | String | Instance set ID |
Header | {token-id} * | String | API authentication token |
Content-Type* | String | Default content type: application/json | |
Body | primaryId * | String | ID of the instance to be promoted to primary |
{
"primaryId": "instance-idid-xxxx-a49f-e705e91db2fb"
}
Response
Status code | Description |
---|---|
200 | Success response for resource modification request |
400 | Invalid request, unable to proceed |
401 | Unauthorized request |
403 | Forbidden, lacking necessary permissions |
404 | Requested resource not found |
500 | Internal server error, unable to proceed |
Field | Type | Description |
---|---|---|
objectId | String | ID of the instance set |
200 OK
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "bbccxxzz-7347-4d87-a49f-e705e91db2fb"
}
Add instance
Add a replica instance. Up to 5 replicas can be created.
Request
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}/replicas" \
-H "X-Auth-Token: {token-id}" \
-H "Content-Type: application/json" \
-d '{Body}'
Type | Parameter | Type | Description |
---|---|---|---|
URL | {instance-set-id} * | String | Instance set ID |
Header | {token-id} * | String | Refer to API authentication token |
Content-Type* | String | Default: application/json | |
Body | subnet* | Object | Subnet information to assign |
subnet.id* | String | Subnet ID |
{
"subnet": { "id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b" }
}
Response
Status code | Description |
---|---|
200 | Successful response to resource modification request |
400 | Unable to process the request due to invalid user input |
401 | Request made by an unauthorized user |
403 | Request made by a user without proper permissions |
404 | The requested resource does not exist |
500 | Unable to process due to internal server error |
Field | Type | Description |
---|---|---|
objectId | String | Instance set ID |
200 OK
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "qqwweerr-7347-4d87-a49f-e705e91db2fb"
}
Set high availability mode
Enable or disable high availability mode. Changes can only be made when the instance set status is Running.
Request
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}/recovery" \
-H "X-Auth-Token: {token-id}" \
-H "Content-Type: application/json" \
-d '{Body}'
type | parameter | type | description |
---|---|---|---|
URL | {instance-set-id} * | String | Instance set ID |
Header | {token-id} * | String | API authentication token reference |
Content-Type* | String | Default content type: application/json | |
Body | enabled* | Boolean | Enable status - true : Enable high availability mode- false : Disable high availability mode |
{
"enabled": true
}
Response
status code | description |
---|---|
200 | Successful response to resource modification request |
400 | The user's request is invalid, and the operation cannot proceed |
401 | Request made by an unauthenticated user |
403 | Request made by a user without the necessary permissions |
404 | The requested resource does not exist |
500 | Unable to proceed due to an internal server error |
field | type | description |
---|---|---|
objectId | String | Instance set ID |
200 OK
content-length: 52
content-type: application/json; charset=UTF-8
{
"objectId": "aassddff-7347-4d87-a49f-e705e91db2fb"
}