Skip to main content

When cluster mode disabled

The following APIs can be used when cluster mode is set to disabled.

caution
  • 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
Create instance set request syntax
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}'
TypeParameterData TypeDescription
Header{token-id}*StringRefer to API authentication token
Content-Type*StringDefault content type: application/json
BodydescriptionStringInstance set description
- Max 100 characters
- Emojis not allowed
- Line breaks (CR, LF) not allowed
replicas*IntegerNumber of nodes
- Total number of nodes, including Primary and Replica
flavorId*StringFlavor ID
instanceSetName*StringInstance 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*BooleanHigh Availability mode
- true: Enabled
- false: Disabled
subnets[]*Object ArrayList of subnets available for placement
subnets[].id*StringSubnet ID
- Subnet ID can be found in Console > VPC > Subnet
subnetAssignments[]*Object ArraySubnet assignments
- Only subnets from the subnets field can be used
subnetAssignments[].primary*ObjectSubnet assigned as Primary
subnetAssignments[].primary.id*StringPrimary subnet ID
subnetAssignments[].replicas[]*Object ArrayList of subnets assigned to Replica
subnetAssignments[].replicas[].id*StringReplica subnet ID
securityGroups[]*Object ArrayList of security groups connected to the instance set
securityGroups[].id*StringSecurity group ID
- Found in Console > VPC > Security Group
backupScheduleObjectAutomatic backup policy
- If not specified, automatic backup is disabled
backupSchedule.cronStringCron 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.retentionLimitIntegerBackup retention period (in days)
- Minimum 1 day, maximum 35 days
port*IntegerRedis port number
- Currently, only 6379 is allowed
projectId*StringProject ID
version*StringRedis version
- Supported versions: 5.0.6, 6.2.5 for non-cluster mode
userObjectDatabase user information
- Account details for database access
user.nameStringDatabase user name
user.passwordStringDatabase user password (encrypted or hashed)
How to encrypt the database user password
parameterGroupId*StringParameter group ID applied to the instance set
Create instance set request body example
{
"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 CodeDescription
201Successful response to resource creation request
400Invalid request, unable to process
401Unauthorized user request
422Request syntax is valid, but unable to process the request
403User does not have the required permissions
409Duplicate request due to the current server state
500Internal server error, unable to process the request
FieldData TypeDescription
objectIdStringInstance set ID
Create instance set response example
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.

Warning

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
Create instance set request syntax
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}'
TypeParameterData TypeDescription
Header{token-id}*StringRefer to API authentication token
Content-Type*StringDefault content type: application/json
BodydescriptionStringInstance set description
- Max 100 characters
- Emojis not allowed
- Line breaks (CR, LF) not allowed
replicas*IntegerNumber of nodes
- Total number of nodes, including Primary and Replica
flavorId*StringFlavor ID
instanceSetName*StringInstance 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*BooleanHigh Availability mode
- true: Enabled
- false: Disabled
subnets[]*Object ArrayList of subnets available for placement
subnets[].id*StringSubnet ID
- Subnet ID can be found in Console > VPC > Subnet
subnetAssignments[]*Object ArraySubnet assignments
- Only subnets from the subnets field can be used
subnetAssignments[].primary*ObjectSubnet assigned as Primary
subnetAssignments[].primary.id*StringPrimary subnet ID
subnetAssignments[].replicas[]*Object ArrayList of subnets assigned to Replica
subnetAssignments[].replicas[].id*StringReplica subnet ID
securityGroups[]*Object ArrayList of security groups connected to the instance set
securityGroups[].id*StringSecurity group ID
- Found in Console > VPC > Security Group
restoreSourceObjectRestore source information
restoreSource.backupNameStringA name from the MemStore backup list
backupScheduleObjectAutomatic backup policy
- If not specified, automatic backup is disabled
backupSchedule.cronStringCron 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.retentionLimitIntegerBackup retention period (in days)
- Minimum 1 day, maximum 35 days
port*IntegerRedis port number
- Currently, only 6379 is allowed
projectId*StringProject ID
version*StringRedis version
- Supported versions: 5.0.6, 6.2.5 for non-cluster mode
userObjectDatabase user information
- Account details for database access
user.nameStringDatabase user name
user.passwordStringDatabase user password (encrypted or hashed)
How to encrypt the database user password
parameterGroupId*StringParameter group ID applied to the instance set
Create instance set Request Body Example
{
"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 CodeDescription
201Successful response to resource creation request
400Invalid request, unable to process
401Unauthorized user request
403User does not have the required permissions
409Duplicate request due to the current server state
500Internal server error, unable to process the request
FieldData TypeDescription
objectIdStringInstance set ID
Create instance set Response Example
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.

Warning

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
Create instance set request syntax
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}'
TypeParameterData TypeDescription
Header{token-id}*StringRefer to API authentication token
Content-Type*StringDefault content type: application/json
BodydescriptionStringInstance set description
- Max 100 characters
- Emojis not allowed
- Line breaks (CR, LF) not allowed
replicas*IntegerNumber of nodes
- Total number of nodes, including Primary and Replica
flavorId*StringFlavor ID
instanceSetName*StringInstance 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*BooleanHigh Availability mode
- true: Enabled
- false: Disabled
subnets[]*Object ArrayList of subnets available for placement
subnets[].id*StringSubnet ID
- Subnet ID can be found in Console > VPC > Subnet
subnetAssignments[]*Object ArraySubnet assignments
- Only subnets from the subnets field can be used
subnetAssignments[].primary*ObjectSubnet assigned as Primary
subnetAssignments[].primary.id*StringPrimary subnet ID
subnetAssignments[].replicas[]*Object ArrayList of subnets assigned to Replica
subnetAssignments[].replicas[].id*StringReplica subnet ID
securityGroups[]*Object ArrayList of security groups connected to the instance set
securityGroups[].id*StringSecurity group ID
- Found in Console > VPC > Security Group
restoreSourceObjectRestore source information
restoreSource.files[]String ArrayObject 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
backupScheduleObjectAutomatic backup policy
- If not specified, automatic backup is disabled
backupSchedule.cronStringCron 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.retentionLimitIntegerBackup retention period (in days)
- Minimum 1 day, maximum 35 days
port*IntegerRedis port number
- Currently, only 6379 is allowed
projectId*StringProject ID
version*StringRedis version
- Supported versions: 5.0.6, 6.2.5 for non-cluster mode
userObjectDatabase user information
- Account details for database access
user.nameStringDatabase user name
user.passwordStringDatabase user password (encrypted or hashed)
How to encrypt the database user password
parameterGroupId*StringParameter group ID applied to the instance set
Create instance set Request Body Example
{
"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 CodeDescription
201Successful response to resource creation request
400The user's request is invalid, unable to process
401Request made by an unauthorized user
403Request made by a user without permission
409A duplicate request occurred due to the current server state
500Internal error, unable to process the request
FieldTypeDescription
objectIdStringInstance set ID
Create instance set Response Example
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
Delete instance set Request Syntax
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}" \
TypeParameterData TypeDescription
Header{token-id}*StringRefer to API authentication token
URL{instance-set-id}*StringInstance set ID
Query{keep-auto-backup}BooleanWhether 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 CodeDescription
200Successful response to resource retrieval/deletion request
400Invalid request, unable to process
401Request made by an unauthorized user
403Request made by a user without permission
404The requested resource does not exist
500Internal error, unable to process the request
FieldData TypeDescription
objectIdStringInstance set ID
Delete instance set Response Example
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
Update instance set Request Syntax
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'
TypeParameterData TypeDescription
Header{token-id}*StringRefer to API authentication token
URL{instance-set-id}*StringInstance set ID
BodybackupScheduleObjectBackup schedule settings
backupSchedule.cronStringCron expression for backup schedule
- Only time can be set
- Uses a 5-field cron expression
- Passing an empty string ("") will delete the backup
backupSchedule.retentionLimitIntegerRetention period for backups (in days)
descriptionStringInstance set description
parameterGroupIdStringID of the parameter group to be linked to the instance set
- Cannot modify parameterGroupId to an empty value
Response
Status CodeDescription
200Successful response to resource retrieval/deletion request
400Invalid request, unable to process
401Request made by an unauthorized user
403Request made by a user without permission
404The requested resource does not exist
500Internal error, unable to process the request
FieldData TypeDescription
objectIdStringInstance set ID
Update instance set Response Example
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
Update backup policy Request Syntax
curl -X PATCH "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}" \
-H "X-Auth-Token: {token-id}" \
-d '{Body}'
TypeParameterData TypeDescription
URL{instance-set-id}*StringInstance set ID
Header{token-id}*StringRefer to API authentication token
BodybackupScheduleObjectBackup schedule settings
backupSchedule.cronStringCron 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.retentionLimitIntegerRetention period for backups (in days)
- Minimum 1 day, maximum 35 days
descriptionStringDescription
Update backup policy Request Body Example
{
"backupSchedule": {
"cron": "* 3 * * *",
"retentionLimit": 15
},
"description": ""
}
Response
Status CodeDescription
200Successful response to the resource update request
400Invalid request, unable to process
401Request made by an unauthorized user
403Request made by a user without permission
404The requested resource does not exist
500Internal error, unable to process the request
FieldData TypeDescription
objectIdStringInstance set ID
Update backup policy Response Example
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
Get instance list Request Syntax
curl -X GET "https://redis.kr-central-2.kakaocloud.com/v1/instance-sets/{instance-set-id}/instances" \
-H "X-Auth-Token: {token-id}" \
TypeParameterData TypeDescription
URL{instance-set-id}*StringInstance set ID
Header{token-id}*StringRefer to API authentication token
Response
Status CodeDescription
200Successful response to resource retrieval/deletion request
400Invalid request, unable to process
401Request made by an unauthorized user
403Request made by a user without permission
500Internal error, unable to process the request
FieldData TypeDescription
sizeIntegerNumber of records
data[]Object ArrayList of instances
data[].instanceNameStringInstance name
data[].descriptionStringInstance set description
data[].projectIdStringProject ID
data[].roleStringInstance role (primary/replica)
data[].flavorIdStringFlavor ID
data[].versionStringRedis version
data[].portIntegerRedis port number
data[].subnetObjectSubnet information
data[].subnet.idStringSubnet ID
data[].creatorStringInstance set creator
data[].objectIdStringInstance ID
data[].endpointStringInstance endpoint (private IP)
data[].licenseStringLicense
data[].createdAtIntegerCreation time (RFC3339)
data[].statusStringInstance status (e.g., PROVISIONING/FAILED)
Get instance list Response Example
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
Delete instance Request Syntax
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}" \
TypeParameterData typeDescription
URL{instance-set-id}*StringID of the instance set
{instance-id}*StringID of the instance
Header{token-id}*StringRefer to API authentication token
Response
Status codeDescription
200Successful response for resource retrieval/deletion request
400Invalid request, cannot proceed
401Request made by unauthorized user
403Request made by user without proper permissions
404Requested resource not found
500Internal error, unable to complete the request
FieldData typeDescription
objectIdStringID of the instance set
Delete instance Response Example
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
Promote replica to primary request syntax
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}'
TypeParameterData typeDescription
URL{instance-set-id}*StringInstance set ID
Header{token-id}*StringAPI authentication token
Content-Type*StringDefault content type: application/json
BodyprimaryId*StringID of the instance to be promoted to primary
Promote replica to primary Request Body Example
{
"primaryId": "instance-idid-xxxx-a49f-e705e91db2fb"
}
Response
Status codeDescription
200Success response for resource modification request
400Invalid request, unable to proceed
401Unauthorized request
403Forbidden, lacking necessary permissions
404Requested resource not found
500Internal server error, unable to proceed
FieldTypeDescription
objectIdStringID of the instance set
Promote replica to primary Response Example
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
Add instance Request Syntax
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}'
TypeParameterTypeDescription
URL{instance-set-id}*StringInstance set ID
Header{token-id}*StringRefer to API authentication token
Content-Type*StringDefault: application/json
Bodysubnet*ObjectSubnet information to assign
subnet.id*StringSubnet ID
Add instance Request Body Example
{
"subnet": { "id": "xxxxxxxx-0a69-4f8b-b56d-59ce12b4d55b" }
}
Response
Status codeDescription
200Successful response to resource modification request
400Unable to process the request due to invalid user input
401Request made by an unauthorized user
403Request made by a user without proper permissions
404The requested resource does not exist
500Unable to process due to internal server error
FieldTypeDescription
objectIdStringInstance set ID
Add instance Response Example
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
Set high availability mode Request Syntax
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}'
typeparametertypedescription
URL{instance-set-id}*StringInstance set ID
Header{token-id}*StringAPI authentication token reference
Content-Type*StringDefault content type: application/json
Bodyenabled*BooleanEnable status
- true: Enable high availability mode
- false: Disable high availability mode
Set high availability mode Request Body Example
{
"enabled": true
}
Response
status codedescription
200Successful response to resource modification request
400The user's request is invalid, and the operation cannot proceed
401Request made by an unauthenticated user
403Request made by a user without the necessary permissions
404The requested resource does not exist
500Unable to proceed due to an internal server error
fieldtypedescription
objectIdStringInstance set ID
Set high availability mode Response Example
200 OK
content-length: 52
content-type: application/json; charset=UTF-8

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