From 18ddf6321e2612b4dd58edfe498fe864f10c26b0 Mon Sep 17 00:00:00 2001 From: jongmin Date: Thu, 5 Mar 2026 15:57:51 +0900 Subject: [PATCH] translation20260305en --- en/notification.md | 172 ++++++ en/parameter-group.md | 19 + en/release-notes.md | 11 + template/en/api-guide-v2.0_template.md | 21 + template/en/api-guide-v3.0_template.md | 70 +++ template/en/api-guide-v4.0_template.md | 605 ++++++++++++++++++++- template/en/backup-and-restore_template.md | 24 + template/en/db-engine_template.md | 16 + template/en/db-instance_template.md | 182 ++++++- 9 files changed, 1115 insertions(+), 5 deletions(-) diff --git a/en/notification.md b/en/notification.md index 2787784b..5df83ef0 100644 --- a/en/notification.md +++ b/en/notification.md @@ -4,6 +4,177 @@ Event refers to an important event that occurs either by RDS for MySQL or by user. Event consists of the event type, the date and time of occurrence, the original source and the message. Event can be viewed from the console, and you can receive notifications of event occurrence by email or SMS through subscription. The event type and the possible events are as follows. +<<<<<<< HEAD +| Event Code | Event Category | Availability | Description | +|-------------|-------------------|--------------|-------------------------------------------------------------------------------| +| BACUP_01_00 | BACKUP | No | Backup of DB instance started | +| BACUP_01_01 | BACKUP | No | Backup of DB instance completed | +| BACUP_01_04 | BACKUP | No | Backup of DB instance failed | +| BACUP_02_01 | BACKUP | Yes | Backup deleted | +| BACUP_04_00 | BACKUP | Yes | Object storage upload started | +| BACUP_04_01 | BACKUP | Yes | Object storage upload completed | +| BACUP_04_04 | BACKUP | Yes | Object storage upload failed | +| BACUP_05_00 | BACKUP | Yes | Backup export started | +| BACUP_05_01 | BACKUP | Yes | Backup exported | +| BACUP_05_04 | BACKUP | Yes | Backup export failed | +| BACUP_06_01 | BACKUP | No | Backup of DB instance failed (Known cause) | +| SECGP_01_01 | DB_SECURITY_GROUP | No | DB security group created | +| SECGP_02_00 | DB_SECURITY_GROUP | No | Changing DB security group started | +| SECGP_02_01 | DB_SECURITY_GROUP | No | Changing DB security group completed | +| SECGP_02_04 | DB_SECURITY_GROUP | No | Changing DB security group failed | +| SECGP_03_01 | DB_SECURITY_GROUP | No | DB security group deleted | +| INSTC_01_00 | INSTANCE | No | Creating DB instance started | +| INSTC_01_01 | INSTANCE | No | Creating DB instance completed | +| INSTC_01_04 | INSTANCE | No | Creating DB instance failed | +| INSTC_02_01 | INSTANCE | Yes | DB instance started | +| INSTC_03_01 | INSTANCE | Yes | DB instanced ended | +| INSTC_04_00 | INSTANCE | Yes | Deleting DB instance started | +| INSTC_04_01 | INSTANCE | Yes | Deleting DB instance completed | +| INSTC_04_04 | INSTANCE | Yes | Deleting DB instance failed | +| INSTC_05_00 | INSTANCE | Yes | Backup of DB instance started | +| INSTC_05_01 | INSTANCE | Yes | Backup of DB instance completed | +| INSTC_05_04 | INSTANCE | Yes | Backup of DB instance failed | +| INSTC_06_00 | INSTANCE | Yes | Restoring DB instance started | +| INSTC_06_01 | INSTANCE | Yes | Restoring DB instance completed | +| INSTC_06_04 | INSTANCE | Yes | Restoring DB instance failed | +| INSTC_07_01 | INSTANCE | Yes | Automated backup setting enabled | +| INSTC_08_01 | INSTANCE | Yes | Automated backup setting disabled | +| INSTC_09_00 | INSTANCE | Yes | Modifying detailed settings started | +| INSTC_09_01 | INSTANCE | Yes | Detailed settings modified | +| INSTC_09_04 | INSTANCE | Yes | Detailed settings modification failed | +| INSTC_10_00 | INSTANCE | Yes | Changing backup and user access control settings started | +| INSTC_10_01 | INSTANCE | Yes | Changing backup and user access control settings completed | +| INSTC_10_04 | INSTANCE | Yes | Changing backup and user access control settings failed | +| INSTC_11_01 | INSTANCE | Yes | User access control modified | +| INSTC_13_01 | INSTANCE | Yes | Associate Floating IP | +| INSTC_14_01 | INSTANCE | Yes | Disconnected to floating IP | +| INSTC_15_00 | INSTANCE | Yes | Replicating DB instance started | +| INSTC_15_01 | INSTANCE | Yes | Replicating DB instance completed | +| INSTC_15_04 | INSTANCE | Yes | Replicating DB instance failed | +| INSTC_16_00 | INSTANCE | Yes | Promoting DB instance started | +| INSTC_16_01 | INSTANCE | Yes | Promoting DB instance completed | +| INSTC_16_04 | INSTANCE | Yes | Promoting DB instance failed | +| INSTC_21_01 | INSTANCE | Yes | DB instance normalized | +| INSTC_22_01 | INSTANCE | Yes | Not enough DB instance storage | +| INSTC_23_01 | INSTANCE | Yes | Connecting DB instance failed | +| INSTC_24_00 | INSTANCE | Yes | Changing DB instance type started | +| INSTC_24_01 | INSTANCE | Yes | Changing DB instance type completed | +| INSTC_24_04 | INSTANCE | Yes | Changing DB instance type failed | +| INSTC_25_00 | INSTANCE | Yes | Storage expansion started | +| INSTC_25_01 | INSTANCE | Yes | Storage expanded | +| INSTC_25_04 | INSTANCE | Yes | Storage expansion failed | +| INSTC_26_00 | INSTANCE | Yes | DB instance failover occurred | +| INSTC_26_01 | INSTANCE | Yes | DB instance failover completed | +| INSTC_26_04 | INSTANCE | Yes | DB instance failover failed | +| INSTC_27_01 | INSTANCE | Yes | DB instance storage secured | +| INSTC_27_04 | INSTANCE | Yes | Securing DB instance storage failed | +| INSTC_28_01 | INSTANCE | Yes | High Availability DB Instance started | +| INSTC_29_01 | INSTANCE | Yes | High Availability DB Instance ended | +| INSTC_30_01 | INSTANCE | Yes | Replication stopped | +| INSTC_31_00 | INSTANCE | Yes | High availability recovery of DB instance with a completed failover started | +| INSTC_31_01 | INSTANCE | Yes | High availability recovery of DB instance with a completed failover completed | +| INSTC_31_04 | INSTANCE | Yes | High availability recovery of DB instance with a completed failover failed | +| INSTC_32_00 | INSTANCE | Yes | High availability rebuilding DB instance with a completed failover started | +| INSTC_32_01 | INSTANCE | Yes | High availability rebuilding DB instance with a completed failover completed | +| INSTC_32_04 | INSTANCE | Yes | High availability rebuilding DB instance with a completed failover failed | +| INSTC_33_00 | INSTANCE | Yes | High availability removal of DB instance with a completed failover started | +| INSTC_33_01 | INSTANCE | Yes | High availability removal of DB instance with a completed failover completed | +| INSTC_33_04 | INSTANCE | Yes | High availability removal of DB instance with a completed failover failed | +| INSTC_34_01 | INSTANCE | Yes | High availability suspended | +| INSTC_34_04 | INSTANCE | Yes | High availability suspension failed | +| INSTC_35_01 | INSTANCE | Yes | High availability restarted | +| INSTC_35_04 | INSTANCE | Yes | High availability restart failed | +| INSTC_36_01 | INSTANCE | Yes | Instance restart using failover | +| INSTC_36_04 | INSTANCE | Yes | Instance restart using failover failed | +| INSTC_37_01 | INSTANCE | Yes | DB User created | +| INSTC_37_04 | INSTANCE | Yes | DB user creation failed | +| INSTC_38_01 | INSTANCE | Yes | DB user updated | +| INSTC_38_04 | INSTANCE | Yes | DB user update failed | +| INSTC_39_01 | INSTANCE | Yes | DB user deleted | +| INSTC_40_01 | INSTANCE | Yes | DB schema created | +| INSTC_40_04 | INSTANCE | Yes | DB schema creation failed | +| INSTC_41_01 | INSTANCE | Yes | DB schema deleted | +| INSTC_42_04 | INSTANCE | No | CPU cores limit | +| INSTC_43_04 | INSTANCE | No | RAM capacity limit | +| INSTC_44_04 | INSTANCE | No | Individual volume limit | +| INSTC_45_04 | INSTANCE | No | Total project volume limit | +| INSTC_46_04 | INSTANCE | No | Read-only slaves limit | +| INSTC_47_00 | INSTANCE | Yes | DB instance backup and export started | +| INSTC_47_01 | INSTANCE | Yes | DB instance backed up and exported | +| INSTC_47_04 | INSTANCE | Yes | DB instance backup and export failed | +| INSTC_48_00 | INSTANCE | Yes | DB instance restoration using backup from the object storage started | +| INSTC_48_01 | INSTANCE | Yes | DB instance using backup from the object storage restored | +| INSTC_48_04 | INSTANCE | Yes | DB instance restoration using backup from the object storage failed | +| INSTC_49_00 | INSTANCE | Yes | DB instance force restart | +| INSTC_50_00 | INSTANCE | Yes | Backup export started | +| INSTC_50_01 | INSTANCE | Yes | Backup exported | +| INSTC_50_04 | INSTANCE | Yes | Backup export failed | +| INSTC_51_01 | INSTANCE | Yes | Backup of DB instance failed | +| INSTC_52_01 | INSTANCE | Yes | DB instance backup and export failed | +| INSTC_53_00 | INSTANCE | Yes | Stopping DB instance started | +| INSTC_53_01 | INSTANCE | Yes | Stopping DB instance completed | +| INSTC_53_04 | INSTANCE | Yes | Stopping DB instance failed | +| INSTC_54_00 | INSTANCE | Yes | DB instance replication rebuilding started | +| INSTC_54_01 | INSTANCE | Yes | DB instance replication rebuilding completed | +| INSTC_54_04 | INSTANCE | Yes | DB instance replication rebuilding failed | +| INSTC_55_01 | INSTANCE | Yes | Failover restart due to replication delay failed | +| INSTC_56_00 | INSTANCE | Yes | Changing DB instance security group started | +| INSTC_56_01 | INSTANCE | Yes | Changing DB instance security group completed | +| INSTC_56_04 | INSTANCE | Yes | Changing DB instance security group failed | +| INSTC_57_00 | INSTANCE | Yes | Changing DB instance with a completed failover to normal instance started | +| INSTC_57_01 | INSTANCE | Yes | Changing DB instance with a completed failover to normal instance completed | +| INSTC_57_04 | INSTANCE | Yes | Changing DB instance with a completed failover to normal instance failed | +| INSTC_58_00 | INSTANCE | Yes | Changing parameter group started | +| INSTC_58_01 | INSTANCE | Yes | Changing parameter group completed | +| INSTC_58_04 | INSTANCE | Yes | Changing parameter group failed | +| INSTC_59_00 | INSTANCE | Yes | Applying parameter group changes started | +| INSTC_59_01 | INSTANCE | Yes | Applying parameter group changes completed | +| INSTC_59_04 | INSTANCE | Yes | Applying parameter group changes failed | +| INSTC_60_00 | INSTANCE | Yes | DB instance migration started | +| INSTC_60_01 | INSTANCE | Yes | DB instance migration completed | +| INSTC_60_04 | INSTANCE | Yes | DB instance migration failed | +| INSTC_61_00 | INSTANCE | Yes | Candidate master rebuilding started | +| INSTC_61_01 | INSTANCE | Yes | Candidate master rebuilding completed | +| INSTC_61_04 | INSTANCE | Yes | Candidate master rebuilding failed | +| INSTC_62_00 | INSTANCE | Yes | DB engine version upgrade started | +| INSTC_62_01 | INSTANCE | Yes | DB engine version upgrade completed | +| INSTC_62_04 | INSTANCE | Yes | DB engine version upgrade failed | +| INSTC_63_01 | INSTANCE | Yes | Decrypt DB instance binary logs | +| INSTC_64_04 | INSTANCE | Yes | DB engine version upgrade pre-check failed | +| INSTC_65_00 | INSTANCE | Yes | Authentication plugin activation started | +| INSTC_65_01 | INSTANCE | Yes | Authentication plugin activation completed | +| INSTC_65_04 | INSTANCE | Yes | Authentication plugin activation failed | +| INSTC_66_00 | INSTANCE | Yes | Force promoting DB instance started | +| INSTC_66_01 | INSTANCE | Yes | Force promoting DB instance completed | +| INSTC_66_04 | INSTANCE | Yes | Force promoting DB instance failed | +| INSTC_67_00 | INSTANCE | Yes | OS version upgrade started | +| INSTC_67_01 | INSTANCE | Yes | OS version upgrade ended | +| INSTC_67_04 | INSTANCE | Yes | OS version upgrade failed | +| INSTC_68_01 | INSTANCE | Yes | Network communication failed | +| INSTC_69_00 | INSTANCE | Yes | Waiting for manual control of failover | +| INSTC_69_01 | INSTANCE | Yes | Manual control of failover succeeded | +| INSTC_69_04 | INSTANCE | Yes | Manual control of failover timeout | +| INSTC_70_01 | INSTANCE | Yes | High availability normalized | +| INSTC_71_01 | INSTANCE | Yes | High availability stopped | +| INSTC_73_00 | INSTANCE | Yes | Auto scale storage started | +| INSTC_73_01 | INSTANCE | Yes | Auto scale storage completed | +| INSTC_73_04 | INSTANCE | Yes | Auto scale storage failed | +| INSTC_75_00 | INSTANCE | Yes | Add VIP started | +| INSTC_75_01 | INSTANCE | Yes | +Add VIP completed | +| INSTC_75_04 | INSTANCE | Yes | Add VIP failed | +| INSTC_76_00 | INSTANCE | Yes | Maintenance started | +| INSTC_76_01 | INSTANCE | Yes | Maintenance completed | +| INSTC_76_02 | INSTANCE | Yes | Maintenance skipped | +| INSTC_76_04 | INSTANCE | Yes | Maintenance failed | +| INSTC_76_05 | INSTANCE | Yes | Failed to schedule maintenance | +| JOB_01_04 | JOB | Yes | Job execution failed | +| TENAT_01_04 | TENANT | Yes | CPU cores limit | +| TENAT_02_04 | TENANT | Yes | RAM capacity limit | +| TENAT_03_04 | TENANT | Yes | Individual volume limit | +| TENAT_04_04 | TENANT | Yes | Total project volume limit | +| TENAT_05_04 | TENANT | Yes | Read-only slaves limit | +======= | Event Code | Event Category | Availability | Description | |-------------------|-------------------|--------------|-------------------------------------------------------------------------------| | BACUP_01_00 | BACKUP | No | Backup of DB instance started | @@ -172,6 +343,7 @@ Event refers to an important event that occurs either by RDS for MySQL or by use | TENAT_03_04 | TENANT | Yes | Individual volume limit | | TENAT_04_04 | TENANT | Yes | Total project volume limit | | TENAT_05_04 | TENANT | Yes | Read-only slaves limit | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0 ## Subscribe to Event diff --git a/en/parameter-group.md b/en/parameter-group.md index f74f2b83..04e40e58 100644 --- a/en/parameter-group.md +++ b/en/parameter-group.md @@ -38,6 +38,25 @@ After selecting two different parameter groups in the console, click the **Compa You are free to delete parameter groups except those already applied to the DB instances. To delete a parameter group already applied to a DB instance, you must first change the parameter group of all connected DB instances before you delete it. +{{#if (eq engine.lowerCase "mysql")}} + +### Cluster Parameter Group + +Cluster Parameter Groups are provided to apply configurations for {{engine.pascalCase}} installed on your DB cluster. These groups are only available for DB clusters and are managed separately from standard DB instance parameter groups. + +#### Constraints + +A cluster parameter group has the following constraints: + +* **DB Cluster Only**: This can only be used with DB instance groups of the DB Cluster type. It cannot be applied to general DB instances. +* **Fixed GTID Parameters**: Global transaction identifier (GTID)-related parameters are preset and cannot be modified. +* `gtid_mode = ON` +* `enforce_gtid_consistency = ON` +* `binlog_format = ROW` +* **Some Parameters Cannot Be Modified**: In addition to GTID-related parameters, some parameters cannot be modified to ensure the stability of the DB cluster. + +{{/if}} + ## Parameter The parameter contains the following information. diff --git a/en/release-notes.md b/en/release-notes.md index b06bc37a..4cddd1d7 100644 --- a/en/release-notes.md +++ b/en/release-notes.md @@ -1,5 +1,15 @@ ## Database > RDS for MySQL > Release Notes +<<<<<<< HEAD +### March 10, 2026 + +#### Feature Updates + +- Added API v4.0 + - For more information, see **API v4.0 guide** document in the user guide. +- Added snapshot backup feature + - Perform backups using Cinder storage snapshots with zero impact on DB performance +======= ### 2026. 03. 10. #### 기능 추가 및 개선 @@ -8,6 +18,7 @@ - 자세한 내용은 사용자 가이드의 **API v4.0 가이드** 문서를 참고하세요. - 스냅숏 백업 기능 추가 - Cinder 스토리지 스냅숏을 이용하여 DB 성능에 영향을 주지 않고 백업 수행 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0 ### January 13, 2026 diff --git a/template/en/api-guide-v2.0_template.md b/template/en/api-guide-v2.0_template.md index e3be3245..0c2456e2 100644 --- a/template/en/api-guide-v2.0_template.md +++ b/template/en/api-guide-v2.0_template.md @@ -6,9 +6,22 @@ | {{this.text.en}} | {{this.endpoint}} | {{/each}} +<<<<<<< HEAD:template/en/api-guide-v2.0.md + +## Authentication and Authorization + +AppKey and SecretKey are required to use the RDS for {{engine.pascalCase}} API. + +An Appkey is a unique authentication key issued for each NHN Cloud service, and a project integrated Appkey is a common authentication key that can be used across multiple services within a single NHN Cloud project. + + + +For more information about how to check and use an Appkey, see [Appkey](/nhncloud/ko/public-api/appkey). For more information about how to create and use a project integrated Appkey, see [Project Integrated Appkey](/nhncloud/ko/public-api/project-integrated-appkey). +======= ## Authentication and Authorization An AppKey or a Project Integrated Appkey is required to use the RDS for {{engine.pascalCase}} API. An AppKey is a unique authentication key issued for each individual NHN Cloud service, while a Project Integrated Appkey is a common authentication key that can be shared across multiple services within a single NHN Cloud project. For more information on checking and using Appkeys, please refer to the [Appkey](/nhncloud/en/public-api/appkey). For more information on creating and using Project Integrated Appkeys, please refer to the [Project Integrated Appkey](/nhncloud/en/public-api/project-integrated-appkey). +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v2.0_template.md ## Monitoring @@ -24,7 +37,11 @@ GET /v2.0/metrics | Name | Type | Format | Required | Description | |--------------|------|--------|----------|-------------------------------------------------| +<<<<<<< HEAD:template/en/api-guide-v2.0.md +| X-TC-APP-KEY | URL | String | O | RDS for {{engine.pascalCase}} Appkey or integrated Appkey for project | +======= | X-TC-APP-KEY | URL | String | O | AppKey or Project Integrated Appkey for RDS for {{engine.pascalCase}} | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v2.0_template.md #### Response @@ -55,7 +72,11 @@ GET /rds/api/v2.0/metric-statistics | Name | Type | Format | Required | Description | |--------------|------|--------|----------|-------------------------------------------------| +<<<<<<< HEAD:template/en/api-guide-v2.0.md +| X-TC-APP-KEY | URL | String | O | RDS for {{engine.pascalCase}} or integrated Appkey for project | +======= | X-TC-APP-KEY | URL | String | O | AppKey or Project Integrated Appkey for RDS for {{engine.pascalCase}} | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v2.0_template.md #### Request diff --git a/template/en/api-guide-v3.0_template.md b/template/en/api-guide-v3.0_template.md index bf312693..3ee07c16 100644 --- a/template/en/api-guide-v3.0_template.md +++ b/template/en/api-guide-v3.0_template.md @@ -1,9 +1,14 @@ ## Database > RDS for {{engine.pascalCase}} > API Guide +## RDS for {{engine.pascalCase}} API Common Information +<<<<<<< HEAD:template/en/api-guide-v3.0.md +### API Endpoint +======= ## RDS for {{engine.pascalCase}} API 공통 정보 ### API 엔드포인트 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v3.0_template.md | Region | Endpoint | |--------|----------| {{#each regions}} @@ -14,7 +19,11 @@ User Access Key is required to use the RDS for {{engine.pascalCase}} API. A User Access Key is an authentication key issued based on an NHN Cloud or IAM account. It is used in conjunction with a Secret Access Key to authenticate API requests. +<<<<<<< HEAD:template/en/api-guide-v3.0.md +User Access Key and Secret Access Key can be issued in the **API Security Settings** from the console. For more information about how to issue and use User Access Key, see [User Access Key](/nhncloud/ko/public-api/user-access-key). +======= User Access Keys and Secret Access Keys can be issued in the console's API Security Setting. For more information on issuing and using User Access Key, please refer to the [User Access Key](/nhncloud/en/public-api/user-access-key). +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v3.0_template.md The created Key must be included in the request Header. @@ -24,6 +33,7 @@ The created Key must be included in the request Header. | X-TC-AUTHENTICATION-ID | Header | String | O | User Access Key ID in API Security Settings menu | | X-TC-AUTHENTICATION-SECRET | Header | String | O | Secret Access Key in API Security Settings menu | + In addition, the APIs you can call are limited based on the project member role. You can grant permissions separately for `RDS for {{engine.pascalCase}} ADMIN` and `RDS for {{engine.pascalCase}} VIEWER`. * `RDS for {{engine.pascalCase}} ADMIN permission holders` can use all available features as before. @@ -1354,11 +1364,42 @@ POST /v3.0/db-instances/{dbInstanceId}/restore |-----------------------------------------------------|------|---------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | dbInstanceId | URL | UUID | O | DB instance identifier | | restore | Body | Object | O | Restoration information object | +<<<<<<< HEAD:template/en/api-guide-v3.0.md +| restore.restoreType | Body | Enum | O | Restoration type
- `TIMESTAMP`: A point-in-time restoration type using the time within the restorable time
- `BINLOG`: A point-in-time restoration type using a binary log location that can be restored
- `BACKUP`: Snapshot restoration type using a previously created backup | +======= | restore.restoreType | Body | Enum | O | Restoration type
- `TIMESTAMP`: A point-in-time restoration type using the time within the restorable time
- `BINLOG`: A point-in-time restoration type using a binary log location that can be restored.
- `BACKUP`: Snapshot restoration type using a previously created backup | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v3.0_template.md | dbInstanceName | Body | String | O | Master name to identify DB instances | | dbInstanceCandidateName | Body | String | X | Candidate name to identify DB instances | | description | Body | String | X | Additional information on DB instances | | dbFlavorId | Body | UUID | O | Identifier of DB instance specifications | +<<<<<<< HEAD:template/en/api-guide-v3.0.md +| dbPort | Body | Number | O | DB port/>- Minimum value: `3306`
- Maximum value: 43306 | +| parameterGroupId | Body | UUID | O | Parameter group identifier | +| dbSecurityGroupIds | Body | Array | X | DB security group identifiers | +| userGroupIds | Body | Array | X | User group identifiers | +| useHighAvailability | Body | Boolean | X | Whether to use high availability
- Default: `false` | +| pingInterval | Body | Number | X | Ping interval (sec) when using high availability
- Default: `6`
- Minimum value: `0`
- Maximum value: 65535 | +| useDefaultNotification | Body | Boolean | X | Whether to use default notification
- Default: `false` | +| network | Body | Object | O | Network information objects | +| network.subnetId | Body | UUID | O | Subnet identifier | +| network.usePublicAccess | Body | Boolean | X | External access is available or not
- Default: `false` | +| network.availabilityZone | Body | Enum | O | Availability zone where DB instance will be created
- Example: `kr-pub-a` | +| storage | Body | Object | O | Data storage information objects | +| storage.storageType | Body | Enum | O | Data Storage Type
- Example: `General SSD` | +| storage.storageSize | Body | Number | O | Data Storage Size (GB)
- Minimum value: `0`
- Maximum value: 65535 | +| backup | Body | Object | O | Backup information objects | +| backup.backupPeriod | Body | Number | O | Backup retention period
- Minimum value: `0`
- Maximum value: 65535 | +| backup.ftwrlWaitTimeout | Body | Number | X | Query latency (sec)
- Default: `6`
- Minimum value: `0`
- Maximum value: 65535 | +| backup.backupRetryCount | Body | Number | X | Number of backup retries
- Default: `0`
- Minimum value: `0`
- Maximum value: 65535 | +{{#if (eq engine.lowerCase "mysql")}} +| backup.replicationRegion | Body | Enum | X | Backup replication region
- `KR1`: Korea (Pangyo) Region
- `KR2`: Korea (Pyeongchon) Region
- `JP1`: Japan (Tokyo) Region | +{{/if}} +| backup.useBackupLock | Body | Boolean | X | Whether to use table lock
- Default: `true` | +| backup.backupSchedules | Body | Array | O | Scheduled auto backup list | +| backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
- Example: `00:00:00` | +| backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +======= | dbPort | Body | Number | O | DB port
- Minimum value: `0`
- Maximum value: 65535 | | parameterGroupId | Body | UUID | O | Parameter group identifier | | dbSecurityGroupIds | Body | Array | X | DB security group identifiers | @@ -1384,6 +1425,7 @@ POST /v3.0/db-instances/{dbInstanceId}/restore | backup.backupSchedules | Body | Array | O | Scheduled auto backup list | | backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
- Example: `1.1.1.%` | | backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v3.0_template.md | useDeletionProtection | Body | Boolean | X | Whether to protect against deletion
Default: `false` | #### Request when restoring a point in time restoration using Timestamp (if restoreType is `TIMESTAMP`) @@ -1574,6 +1616,33 @@ POST /v3.0/db-instances/restore-from-obs | dbInstanceCandidateName | Body | String | X | Candidate name to identify DB instances | | description | Body | String | X | Additional information on DB instances | | dbFlavorId | Body | UUID | O | Identifier of DB instance specifications | +<<<<<<< HEAD:template/en/api-guide-v3.0.md +| dbPort | Body | Number | O | DB port
- Minimum value: `3306`
- Maximum value: `43306` | +| parameterGroupId | Body | UUID | O | Parameter group identifier | +| dbSecurityGroupIds | Body | Array | X | DB security group identifiers | +| userGroupIds | Body | Array | X | User group identifiers | +| useHighAvailability | Body | Boolean | X | Whether to use high availability
- Default: `false` | +| pingInterval | Body | Number | X | Ping interval (sec) when using high availability
- Default: `6`
- Minimum value: `0`
- Maximum value: 65535 | +| useDefaultNotification | Body | Boolean | X | Whether to use default notification
- Default: `false` | +| network | Body | Object | O | Network information objects | +| network.subnetId | Body | UUID | O | Subnet identifier | +| network.usePublicAccess | Body | Boolean | X | External access is available or not
- Default: `false` | +| network.availabilityZone | Body | Enum | O | Availability zone where DB instance will be created
- Example: `kr-pub-a` | +| storage | Body | Object | O | Storage information objects | +| storage.storageType | Body | Enum | O | Block Storage Type
- Example: `General SSD` | +| storage.storageSize | Body | Number | O | Block Storage Size (GB)
- Minimum value: `20`
- Maximum value: `2048` | +| backup | Body | Object | O | Backup information objects | +| backup.backupPeriod | Body | Number | O | Backup retention period
- Minimum value: `0`
- Maximum value: `730` | +| backup.ftwrlWaitTimeout | Body | Number | X | Query latency (sec)
- Default: `6`
- Minimum value: `0`
- Maximum value: `21600` | +| backup.backupRetryCount | Body | Number | X | Number of backup retries
- Default: `0`
- Minimum value: `0`
- Maximum value: `10` | +{{#if (eq engine.lowerCase "mysql")}} +| backup.replicationRegion | Body | Enum | X | Backup replication region
- `KR1`: Korea (Pangyo) Region
- `KR2`: Korea (Pyeongchon) Region
- `JP1`: Japan (Tokyo) Region | +{{/if}} +| backup.useBackupLock | Body | Boolean | X | Whether to use table lock
- Default: `true` | +| backup.backupSchedules | Body | Array | O | Scheduled auto backup list | +| backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
| +| backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +======= | dbPort | Body | Number | O | DB port
- Minimum value: `0`
- Maximum value: 65535 | | parameterGroupId | Body | UUID | O | Parameter group identifier | | dbSecurityGroupIds | Body | Array | X | DB security group identifiers | @@ -1599,6 +1668,7 @@ POST /v3.0/db-instances/restore-from-obs | backup.backupSchedules | Body | Array | O | Scheduled auto backup list | | backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
- Example: `1.1.1.%` | | backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v3.0_template.md diff --git a/template/en/api-guide-v4.0_template.md b/template/en/api-guide-v4.0_template.md index 99cc9967..d356eaf2 100644 --- a/template/en/api-guide-v4.0_template.md +++ b/template/en/api-guide-v4.0_template.md @@ -1,8 +1,14 @@ ## Database > RDS for {{engine.pascalCase}} > API Guide +<<<<<<< HEAD:template/en/api-guide-v4.0.md +## RDS for {{engine.pascalCase}} API Common Information + +### API Endpoint +======= ## RDS for {{engine.pascalCase}} API 공통 정보 ### API 엔드포인트 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | Region | Endpoint | |--------|----------| @@ -12,7 +18,11 @@ ### Authentication and Authorization +<<<<<<< HEAD:template/en/api-guide-v4.0.md +RDS for {{engine.pascalCase}} uses User Access Key tokens for authentication and authorization when making API calls. The User Access Key token is a temporary, Bearer-type access token issued from a User Access Key. For more information about how to issue and use User Access Key tokens, see [User Access Key Token](/nhncloud/ko/public-api/user-access-key-token). +======= RDS for {{engine.pascalCase}} uses User Access Key tokens for authentication and authorization when making API calls. The User Access Key token is a temporary, Bearer-type access token issued from a User Access Key. For more information on issuing and using User Access Key tokens, please refer to the [User Access Key Token](/nhncloud/en/public-api/user-access-key-token). +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md The issued token must be included in the request header along with the Appkey. | Name | Type | Format | Required | Description | @@ -959,8 +969,13 @@ PUT /v4.0/db-instances/{dbInstanceId} | dbSecurityGroupIds | Body | Array | X | DB security group identifiers | | executeBackup | Body | Boolean | X | Whether to execute backup at this time
Default: `false` | | useOnlineFailover | Body | Boolean | X | Whether to restart using failover
Available only for DB instance using high availability
Default: `false` | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| waitReplicationDelay | Body | Boolean | X | Wait for replication lag to clear
Available only for DB instances with high availability enabled.
- Default: `false` | +| useReadOnly | Body | Boolean | X | Switch to read-only mode
Available only for DB instances with high availability enabled.
- Default: `false` | +======= | waitReplicationDelay | Body | Boolean | X | 복제 지연 해소 대기 여부
고가용성을 사용 중인 DB 인스턴스에서만 사용 가능합니다.
- 기본값: `false` | | useReadOnly | Body | Boolean | X | 읽기 전용으로 변경 여부
고가용성을 사용 중인 DB 인스턴스에서만 사용 가능합니다.
- 기본값: `false` | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md
Example

@@ -1000,11 +1015,18 @@ DELETE /v4.0/db-instances/{dbInstanceId} #### Request +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| Name | Type | Format | Required | Description | +|--------------|------|--------|----------|------------------------| +| dbInstanceId | URL | UUID | O | DB instance identifier | +| deleteAutoBackup | Body | Boolean | X | Delete automated backups
- Default: `false` | +======= | Name | Type | Format | Required | Description | |--------------|------|--------|----------|------------------------| | dbInstanceId | URL | UUID | O | DB instance identifier | | deleteAutoBackup | Body | Boolean | X | 자동 백업 삭제 여부
- 기본값: `false` | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md #### Response @@ -1033,8 +1055,13 @@ POST /v4.0/db-instances/{dbInstanceId}/restart | dbInstanceId | URL | UUID | O | DB instance identifier | | useOnlineFailover | Body | Boolean | X | Whether to restart using failover
Available only for DB instance using high availability
Default: `false` | | executeBackup | Body | Boolean | X | Whether to execute backup at this time
Default: `false` | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| waitReplicationDelay | Body | Boolean | X | Wait for replication lag to clear
Available only for DB instances with high availability enabled.
- Default: `false` | +| useReadOnly | Body | Boolean | X | Switch to read-only mode
Available only for DB instances with high availability enabled.
- Default: `false` +======= | waitReplicationDelay | Body | Boolean | X | 복제 지연 해소 대기 여부
고가용성을 사용 중인 DB 인스턴스에서만 사용 가능합니다.
- 기본값: `false` | | useReadOnly | Body | Boolean | X | 읽기 전용으로 변경 여부
고가용성을 사용 중인 DB 인스턴스에서만 사용 가능합니다.
- 기본값: `false` | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md #### Response @@ -1042,6 +1069,7 @@ POST /v4.0/db-instances/{dbInstanceId}/restart |-------|------|--------|------------------------------| | jobId | Body | UUID | Identifier of requested task | + --- ### Force Restart DB instance ```http @@ -1058,6 +1086,10 @@ POST /v4.0/db-instances/{dbInstanceId}/force-restart This API does not require a request body. +<<<<<<< HEAD:template/en/api-guide-v4.0.md + +======= +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | Name | Type | Format | Required | Description | |--------------|------|--------|----------|------------------------| | dbInstanceId | URL | UUID | O | DB instance identifier | @@ -1159,7 +1191,11 @@ POST /v4.0/db-instances/{dbInstanceId}/replicate | Name | Type | Format | Required | Description | |----------------------------------------------|------|---------|----------|-------------------------------------------------------------------------------------------------------------------------| | dbInstanceId | URL | UUID | O | DB instance identifier | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| dbInstanceName | Body | String | O | Name to identify DB instances +======= | dbInstanceName | Body | String | O | Name to identify DB instances | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | description | Body | String | X | Additional information on DB instances | | dbFlavorId | Body | UUID | X | Identifier of DB instance specifications
- Default: Original DB instance value | | dbPort | Body | Number | X | DB port
- Default: Original DB instance value
- Minimum value: `3306`
- Maximum value: `43306` | @@ -1168,17 +1204,26 @@ POST /v4.0/db-instances/{dbInstanceId}/replicate | userGroupIds | Body | Array | X | User group identifiers | | useDefaultNotification | Body | Boolean | X | Whether to use default notification
Default: `false` | | useDeletionProtection | Body | Boolean | X | Whether to protect against deletion
Default: `false` | -| useSlowQueryAnalysis | Body | Boolean | X | Slow query 분석 여부
- 기본값: `true` | +| useSlowQueryAnalysis | Body | Boolean | X | Whether to analyze Slow query
- Default: `true` | | network | Body | Object | O | Network information objects | | network.usePublicAccess | Body | Boolean | X | External access is available or not
- Default: Original DB instance value | | network.availabilityZone | Body | Enum | O | Availability zone where DB instance will be created
- Example: `kr-pub-a` | | storage | Body | Object | X | Storage information objects | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| storage.storageType | Body | Enum | X | Data storage type
- Default: Source DB instance value
- e.g., `General SSD` | +| storage.storageSize | Body | Number | X | Block Storage Size (GB)
- Default: Original DB instance value
- Minimum value: `20`
- Maximum value: `2048` | +| storage.storageAutoscale | Body | Object | X | Block Storage Auto Scaling Objects | +| storage.storageAutoscale.useStorageAutoscale | Body | Boolean | X | Whether to enable storage auto scaling | +| storage.storageAutoscale.threshold | Body | Number | X | Auto scale out conditions (%)
- Default: Source DB instance vallue
- Minimum value: `50`
- Maximum value: `95` | +| storage.storageAutoscale.maxStorageSize | Body | Number | X | Auto scaling maximum size (GB)
- Default: Source DB instance vallue
- Maximum value:: `4096` | +======= | storage.storageType | Body | Enum | X | Block Storage Type
- Default: Original DB instance value
- Example: `General SSD` | | storage.storageSize | Body | Number | X | Block Storage Size (GB)
- Default: Original DB instance value
- Minimum value: `20`
- Maximum value: `2048` | | storage.storageAutoscale | Body | Object | X | Block Storage Auto Scaling Objects | | storage.storageAutoscale.useStorageAutoscale | Body | Boolean | X | Whether to enable storage auto scaling | | storage.storageAutoscale.threshold | Body | Number | X | Auto scale out conditions (%)
- Default: Original DB instance value
- Minimum value: `50`
- Maximum value: `95` | | storage.storageAutoscale.maxStorageSize | Body | Number | X | Auto scaling maximum size (GB)
- Default: Original DB instance value
- Maximum value: `4096` | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | storage.storageAutoscale.cooldownTime | Body | Number | X | Auto scaling cooldown time (minutes)
- Minimum value: `10`
- Maximum value: `1440` | | backup | Body | Object | X | Backup information objects | | backup.backupPeriod | Body | Number | X | Backup retention period
- Default: Original DB instance value
- Minimum value: `0`
- Maximum value: `730` | @@ -1439,6 +1484,51 @@ POST /v4.0/db-instances/{dbInstanceId}/restore | Name | Type | Format | Required | Description | |-----------------------------------------------------|------|---------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| Name | Type | Format | Required | Description | +|-----------------------------------------------------|------|---------|----|------------------------------------------------------------------------------------------------------------------------------------------------------| +| dbInstanceId | URL | UUID | O | DB instance identifier | +| restore | Body | Object | O | Restoration information object | +| restore.restoreType | Body | Enum | O | Restoration type
- `TIMESTAMP`: A point-in-time restoration type using the time within the restorable time
- `BINLOG`: A point-in-time restoration type using a binary log location that can be restored
- `BACKUP`: Snapshot restoration type using a previously created backup | +| dbInstanceName | Body | String | O | Name to identify DB instances | +| dbInstanceCandidateName | Body | String | O | Name to identify DB instances
- Required to use high availability | +| description | Body | String | X | Additional information on DB instances | +| dbFlavorId | Body | UUID | X | Identifier of DB instance specifications | +| dbPort | Body | Number | X | DB port
- Default: Source DB instance value
- Minimum value: `3306`
- Maximum value: `43306` | +| parameterGroupId | Body | UUID | X | Parameter group identifier
- Default: Source DB instance value | +| dbSecurityGroupIds | Body | Array | X | DB security group identifiers | +| userGroupIds | Body | Array | X | User group identifiers | +| useHighAvailability | Body | Boolean | X | +Whether to use high availability
- Default: `false` | +| pingInterval | Body | Number | X | Ping interval (sec) when using high availability
- Default: `3`
- Minimum value: `1`
- Maximum value: `600` | +| useDefaultNotification | Body | Boolean | X | Whether to use default notification
- Default: `false` | +| useDeletionProtection | Body | Boolean | X | Whether to protect against deletion
Default: `false` | +| useSlowQueryAnalysis | Body | Boolean | X | Whether to use Slow Query analysis
- Default: `true` | +| network | Body | Object | X | Network information objects | +| network.subnetId | Body | UUID | X | Subnet identifier
- Default: Source DB instance value | +| network.usePublicAccess | Body | Boolean | X | +External access is available or not
- Default: `false` | +| network.availabilityZone | Body | Enum | X | Availability zone where DB instance will be created
- e.g., `kr-pub-a`
- Default: Randomly selected | +| storage | Body | Object | X | Data storage information objects | +| storage.storageType | Body | Enum | X | Data storage type
- e.g., `General SSD`
- Default: Source DB instance value | +| storage.storageSize | Body | Number | X | Data storage size (GB)
- Default: Source DB instance value
- Minimum value: `20`
- Maximum value: `2048` | +| storage.storageAutoscale | Body | Object | X | Data storage auto scale objects | +| storage.storageAutoscale.useStorageAutoscale | Body | Boolean | X | Storage autoscaling | +| storage.storageAutoscale.threshold | Body | Number | X | Auto scale conditions (%)
- Default: Source DB instance value
- Minimum value: `50`
- Maximum value: `95` | +| storage.storageAutoscale.maxStorageSize | Body | Number | X | Maximum auto scale size (GB)
- Default: Source DB instance value
- Maximum value: `4096` | +| storage.storageAutoscale.cooldownTime | Body | Number | X | Auto scale cooldown (min)
- Default: Source DB instance value
- Minimum value: `10`
- Maximum value: `1440` | +| backup | Body | Object | X | Backup information objects | +| backup.backupPeriod | Body | Number | X | Backup retention period (day)
- Default: Source DB instance value
- Minimum value: `0`
- Maximum value: `730` | +| backup.ftwrlWaitTimeout | Body | Number | X | Query latency (sec)
- Default: `1800`
- Minimum value: `0`
- Maximum value: `21600` | +| backup.backupRetryCount | Body | Number | X | Backup retry count
- Default: `0`
- Minimum value: `0`
- Maximum value: `10` | +{{#if (eq engine.lowerCase "mysql")}} +| backup.replicationRegion | Body | Enum | X | Backup replication region
- `KR1`: Korea (Pangyo) Region
- `KR2`: Korea (Pyeongchon) region
- `JP1`: Japan (Tokyo) region | +{{/if}} +| backup.useBackupLock | Body | Boolean | X | Whether to use table lock
- Default: `true` | +| backup.backupSchedules | Body | Array | X | Scheduled auto backup list
- Default: Source DB instance value | +| backup.backupSchedules.backupWndBgnTime | Body | String | X | Backup start time
- e.g., `00:00:00` | +| backup.backupSchedules.backupWndDuration | Body | Enum | X | Backup Duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.30 hours
- `TWO_HOURS`: 2 hours
- `TWO_HOURS_AND_HALF`: 2.30 hours
- `THREE_HOURS`: 3 hours | +======= | dbInstanceId | URL | UUID | O | DB instance identifier | | restore | Body | Object | O | Restoration information object | | restore.restoreType | Body | Enum | O | Restoration type
- `TIMESTAMP`: A point-in-time restoration type using the time within the restorable time
- `BINLOG`: A point-in-time restoration type using a binary log location that can be restored.
- `BACKUP`: Snapshot restoration type using a previously created backup | @@ -1478,6 +1568,7 @@ POST /v4.0/db-instances/{dbInstanceId}/restore | backup.backupSchedules | Body | Array | X | Scheduled auto backup list | | backup.backupSchedules.backupWndBgnTime | Body | String | X | Backup started time
- Example: `1.1.1.%` | | backup.backupSchedules.backupWndDuration | Body | Enum | X | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md #### Request when restoring a point in time restoration using Timestamp (if restoreType is `TIMESTAMP`) @@ -1673,38 +1764,67 @@ POST /v4.0/db-instances/restore-from-obs | dbInstanceCandidateName | Body | String | O | Candidate name to identify DB instances | | description | Body | String | X | Additional information on DB instances | | dbFlavorId | Body | UUID | O | Identifier of DB instance specifications | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| dbPort | Body | Number | O | DB port
- Minimum value: `3306`
- Maximum value: `43306` | +| parameterGroupId | Body | UUID | O | Parameter group identifier | +| dbSecurityGroupIds | Body | Array | X | DB security group identifiers | +| userGroupIds | Body | Array | X | User group identifiers | +| useHighAvailability | Body | Boolean | X | Whether to use high availability
- Default: `false` | +| pingInterval | Body | Number | X | Ping interval (sec) when using high availability
- Default: `3`
- Minimum value: `1`
- Maximum value: `600` | +======= | dbPort | Body | Number | O | DB port
- Minimum value: `0`
- Maximum value: 65535 | | parameterGroupId | Body | UUID | O | Parameter group identifier | | dbSecurityGroupIds | Body | Array | X | DB security group identifiers | | userGroupIds | Body | Array | X | User group identifiers | | useHighAvailability | Body | Boolean | X | Whether to use high availability
- Default: `false` | | pingInterval | Body | Number | X | Ping interval (sec) when using high availability
- Default: `6`
- Minimum value: `0`
- Maximum value: 65535 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | useDefaultNotification | Body | Boolean | X | Whether to use default notification
- Default: `false` | | useDeletionProtection | Body | Boolean | X | Whether to protect against deletion
Default: `false` | | useSlowQueryAnalysis | Body | Boolean | X | Whether to analyze slow queries
- Default: `true` | | network | Body | Object | O | Network information objects | | network.subnetId | Body | UUID | O | Subnet identifier | | network.usePublicAccess | Body | Boolean | X | External access is available or not
- Default: `false` | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| network.availabilityZone | Body | Enum | O | Availability zone where DB instance will be created
- Example: `kr-pub-a` | +| storage | Body | Object | O | Storage information objects | +| storage.storageType | Body | Enum | O | Block Storage Type
- Example: `General SSD` | +| storage.storageSize | Body | Number | O | Block Storage Size (GB)
- Minimum value: `20`
- Maximum value: `2048` | +======= | network.availabilityZone | Body | Enum | O | Availability zone where DB instance will be created
- Example: `kr-pub-a` | | storage | Body | Object | O | Storage information objects | | storage.storageType | Body | Enum | O | Block Storage Type
- Example: `General SSD` | | storage.storageSize | Body | Number | O | Block Storage Size (GB)
- Minimum value: `0`
- Maximum value: 65535 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | storage.storageAutoscale | Body | Object | X | Block Storage Auto Scaling Objects | | storage.storageAutoscale.useStorageAutoscale | Body | Boolean | X | Whether to enable storage auto scaling | | storage.storageAutoscale.threshold | Body | Number | X | Auto scale out conditions (%)
- Minimum value: `50`
- Maximum value: `95` | | storage.storageAutoscale.maxStorageSize | Body | Number | X | Auto scaling maximum size (GB)
- Maximum value: `4096` | | storage.storageAutoscale.cooldownTime | Body | Number | X | Auto scaling cooldown time (minutes)
- Minimum value: `10`
- Maximum value: `1440` | | backup | Body | Object | O | Backup information objects | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| backup.backupPeriod | Body | Number | O | Backup retention period (day)
- Minimum value: `0`
- Maximum value: `730` | +| backup.ftwrlWaitTimeout | Body | Number | X | Query latency (sec)
- Default: `1800`
- Minimum value: `0`
- Maximum value: `21600` | +| backup.backupRetryCount | Body | Number | X | Backup retry count
- Default: `0`
- Minimum value: `0`
- Maximum value: `10` | +{{#if (eq engine.lowerCase "mysql")}} +| backup.replicationRegion | Body | Enum | X | Backup replication region

| +======= | backup.backupPeriod | Body | Number | O | Backup retention period
- Minimum value: `0`
- Maximum value: 65535 | | backup.ftwrlWaitTimeout | Body | Number | X | Query latency (sec)
- Default: `6`
- Minimum value: `0`
- Maximum value: 65535 | | backup.backupRetryCount | Body | Number | X | Number of backup retries
- Default: `0`
- Minimum value: `0`
- Maximum value: 65535 | {{#if (eq engine.lowerCase "mysql")}} | backup.replicationRegion | Body | Enum | X | Backup replication region
- `KR1`: Korea (Pangyo) Region
- `KR2`: Korea (Pyeongchon) Region
- `JP1`: Japan (Tokyo) Region | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md {{/if}} | backup.useBackupLock | Body | Boolean | X | Whether to use table lock
- Default: `true` | | backup.backupSchedules | Body | Array | O | Scheduled auto backup list | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
| +| backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +======= | backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
- Example: `1.1.1.%` | | backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md @@ -1825,7 +1945,11 @@ PUT /v4.0/db-instances/{dbInstanceId}/high-availability | dbInstanceId | URL | UUID | O | DB instance identifier | | useHighAvailability | Body | Boolean | O | Whether to use high availability | | pingInterval | Body | Number | X | Ping interval (sec) when using high availability
- Minimum value: `1`
- Maximum value: `600` | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| dbInstanceCandidateName | Body | String | O | Name to identify DB instances
- Required for using high availability | +======= | dbInstanceCandidateName | Body | String | O | DB 인스턴스를 식별할 수 있는 예비 마스터 이름 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md #### Response @@ -2729,6 +2853,219 @@ POST /v4.0/db-instances/{dbInstanceId}/log-files/export |-------|------|--------|------------------------------| | jobId | Body | UUID | Identifier of requested task | +--- +### View BinLog Lists + +```http +GET /v4.0/db-instances/{dbInstanceId}/binlogs +``` + +#### Required Permission + +| Permission | Description | +|---------------------------------------------------|---------------| +| RDSfor{{engine.pascalCase}}:DbInstanceBinLog.List | View BinLog lists | + +#### Request + +This API does not require a request body. + +| Name | Type | Format | Required | Description | +|--------------|-------|---------|----|---------------------------------------------------------------------------------------| +| dbInstanceId | URL | UUID | O | DB instance identifier | +| deletable | Query | Boolean | X | Show only deletable BinLogs
- `true`: Exclude latest BinLog
- `false`: All
- Default: `false` | + +#### Response + +| Name | Type | Format | Description | +|------------------------|------|----------|-----------------------------------| +| binLogs | Body | Array | BinLog file list | +| binLogs.binLogFileName | Body | String | BinLog file name | +| binLogs.binLogFileSize | Body | Number | BinLog file size (Byte) | +| binLogs.createdYmdt | Body | DateTime | Created at(YYYY-MM-DDThh:mm:ss.SSSTZD) | + +
Example +

+ +```json +{ + "header": { + "resultCode": 0, + "resultMessage": "SUCCESS", + "isSuccessful": true + }, + "binLogs": [ + { + "binLogFileName": "mysql-bin.000001", + "binLogFileSize": 1073741824, + "createdYmdt": "2023-03-17T14:02:29+09:00" + } + ] +} +``` + +

+
+ +--- + +### Delete BinLog + +```http +POST /v4.0/db-instances/{dbInstanceId}/binlogs/purge +``` + +#### Required Permission + +| Permission | Description | +|----------------------------------------------------|------------| +| RDSfor{{engine.pascalCase}}:DbInstanceBinLog.Purge | Delete BinLog | + +#### Request + +| Name | Type | Format | Required | Description | +|--------------------|------|--------|----|----------------------------------------| +| dbInstanceId | URL | UUID | O | DB instance identifier | +| lastBinLogFileName | Body | String | O | Last BinLog file name to delete (delete all files prior to this file) | + +
Example +

+ +```json +{ + "lastBinLogFileName": "mysql-bin.000010" +} +``` + +

+
+ +#### Response + +This API does not return a response body. + +
Example +

+ +```json +{ + "header": { + "resultCode": 0, + "resultMessage": "SUCCESS", + "isSuccessful": true + } +} +``` + +

+
+ +--- + +### View Certificate File Lists + +```http +GET /v4.0/db-instances/{dbInstanceId}/certificates +``` + +#### Required Permission + +| Permission | Description | +|--------------------------------------------------------|---------------| +| RDSfor{{engine.pascalCase}}:DbInstanceCertificate.List | View certificate file lists | + +#### Request + +This API does not require a request body. + +| Name | Type | Format | Required | Description | +|--------------|-----|------|----|---------------| +| dbInstanceId | URL | UUID | O | DB instance identifier | + +#### Response + +| Name | Type | Format | Description | +|------------------------------|------|----------|------------------------------------------------------------------------------| +| certificates | Body | Array | Certificate file list | +| certificates.fileName | Body | String | Certificate file name | +| certificates.certificateType | Body | Enum | Certificate type
- `CA_FILE`: CA certificate
- `CERT_FILE`: certificate
- `KEY_FILE`: Secret key | +| certificates.fileSize | Body | Number | Certificate file size (Byte) | +| certificates.createdYmdt | Body | DateTime | Created at(YYYY-MM-DDThh:mm:ss.SSSTZD) | + +
Example +

+ +```json +{ + "header": { + "resultCode": 0, + "resultMessage": "SUCCESS", + "isSuccessful": true + }, + "certificates": [ + { + "fileName": "ca.pem", + "certificateType": "CA_FILE", + "fileSize": 2048, + "createdYmdt": "2023-03-17T14:02:29+09:00" + } + ] +} +``` + +

+
+ +--- + +### Export a Certificate File + +```http +POST /v4.0/db-instances/{dbInstanceId}/certificates/upload +``` + +#### Required Permission + +| Permission | Description | +|----------------------------------------------------------|-------------| +| RDSfor{{engine.pascalCase}}:DbInstanceCertificate.Export | Export a certificate file | + +#### Request + +| Name | Type | Format | Required | Description | +|------------------|------|--------|----|------------------------------------------------------------------------------| +| dbInstanceId | URL | UUID | O | DB instance identifier | +| certificateTypes | Body | Array | O | Certificate type to upload
- `CA_FILE`: CA certificate
- `CERT_FILE`: Certificate
- `KEY_FILE`: Secret key | +| tenantId | Body | String | O | Tenant ID of object storage to store certificate file | +| username | Body | String | O | NHN Cloud member or IAM member ID | +| password | Body | String | O | API password for object storage where certificate file is stored | +| targetContainer | Body | String | O | Object storage container where certificate file is stored | +| objectPath | Body | String | O | +Certificate file path to be stored in container | + +
Example +

+ +```json +{ + "certificateTypes": ["CA_FILE", "CERT_FILE", "KEY_FILE"], + "tenantId": "399631c404744dbbb18ce4fa2dc71a5a", + "username": "gildong.hong@nhn.com", + "password": "password", + "targetContainer": "container", + "objectPath": "certificates/" +} +``` + +

+
+ +#### Response + +| Name | Type | Format | Description | +|-------|------|------|-------------| +| jobId | Body | UUID | Identifier of requested task | + --- ### BinLog 목록 보기 @@ -2956,12 +3293,58 @@ POST /v4.0/db-instances/{dbInstanceId}/certificates/upload | `DELETED` | Backup is deleted | | `ERROR` | Error occurred | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +### View Backup Details +======= ### 백업 상세 보기 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md ```http GET /v4.0/backups/{backupId} ``` +<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Required Permission + +| Permission | Description | +|----------------------------------------|----------| +| RDSfor{{engine.pascalCase}}:Backup.Get | View backup details | + +#### Request + +This API does not require a request body. + +| Name | Type | Format | Required | Description | +|----------|-----|------|----|---------| +| backupId | URL | UUID | O | Backup identifier |Expand commentComment on line R2988Resolved + +#### Response + +| Name | Type | Format | Description | +|-------------------------|------|----------|-----------------| +| backup | Body | Object | Back details | +| backup.backupId | Body | UUID | Backup identifier | +| backup.regionCode | Body | Enum | Region code | +| backup.backupName | Body | String | Name to identify backups | +| backup.backupStatus | Body | Enum | Backup current status | +| backup.dbInstanceId | Body | UUID | Source DB instance identifier | +| backup.dbInstanceName | Body | String | Source DB instance name | +| backup.dbVersion | Body | Enum | DB engine version | +{{#if (eq engine.lowerCase "mysql")}} +| backup.utilVersion | Body | String | xtrabackup utility version used in backup | +{{/if}} +| backup.backupType | Body | Enum | Backup type | +| backup.backupMethodType | Body | Enum | Backup method | +| backup.backupFileType | Body | Enum | Backup file type | +| backup.backupSize | Body | Number | Backup size (Byte) | +| backup.isReplicable | Body | Boolean | Replicable | +| backup.binLogFileName | Body | String | Binary log file name | +| backup.binLogPosition | Body | Number | Binary log location | +| backup.createdYmdt | Body | DateTime | Created at (YYYY-MM-DDThh:mm:ss.SSSTZD) | +| backup.updatedYmdt | Body | DateTime | Updated at (YYYY-MM-DDThh:mm:ss.SSSTZD) | + +
Example +======= #### 필요 권한 | 권한명 | 설명 | @@ -3002,6 +3385,7 @@ GET /v4.0/backups/{backupId} | backup.updatedYmdt | Body | DateTime | 수정 일시(YYYY-MM-DDThh:mm:ss.SSSTZD) |
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -3056,10 +3440,17 @@ GET /v4.0/backups This API does not require a request body. +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| Name | Type | Format | Required | Description | +|-------------------|-------|----------|----|--------------------------------------------------------------------------------------------------------------------------------------| +| page | Query | Number | X | Page to retrieve
- Default: 1
- Minimum value: `1` | +| size | Query | Number | X | Page size to retrieve
- Default: 20 | +======= | Name | Type | Format | Required | Description | |-------------------|-------|----------|----|--------------------------------------------------------------------------------------------------------------------------------------| | page | Query | Number | X | 조회할 목록의 페이지
- 기본값: 1
- 최솟값: `1` | | size | Query | Number | X | 조회할 목록의 페이지 크기
- 기본값: 20 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | backupType | Query | Enum | X | Backup type
- `AUTO`: Automatic
- `MANUAL`: Manual
- Default value: All | | dbInstanceId | Query | UUID | X | Original DB instance identifier | | dbVersion | Query | Enum | X | DB engine type | @@ -3132,10 +3523,17 @@ POST /v4.0/backups #### Common Request +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| Name | Type | Format | Required | Description | +|------------------|------|--------|----|--------------------------------------------------------------------------------------| +| backupName | Body | String | O | Name to identify backups | +| backupMethodType | Body | Enum | O | Backup method type
- `FULL`: Full backup
- `INCREMENTAL`: Incremental backup
- `SNAPSHOT`: Snapshot backup | +======= | Name | Type | Format | Required | Description | |------------------|------|--------|----------|----------------------------------------------------------------------------------------------------------------| | backupName | Body | String | O | Backup name | | backupMethodType | Body | Enum | O | Backup method type
- `FULL`: Full backup
- `INCREMENTAL`: Incremental backup
- `SNAPSHOT`: 스냅숏 백업 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md #### If backupMethodType is `FULL` @@ -3180,6 +3578,16 @@ POST /v4.0/backups

+<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Snapshot Backup (if backupMethodType is `SNAPSHOT`) + +| Name | Type | Format | Required | Description | +|--------------|------|------|----|--------------| +| dbInstanceId | Body | UUID | O | DB instance identifier | + + +
Example +======= #### 스냅숏 백업(backupMethodType이 `SNAPSHOT`인 경우) @@ -3190,6 +3598,7 @@ POST /v4.0/backups
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -3279,9 +3688,15 @@ POST /v4.0/backups/{backupId}/restore | dbInstanceName | Body | String | O | Master name to identify DB instances | | dbInstanceCandidateName | Body | String | X | Candidate name to identify DB instances | | description | Body | String | X | Additional information on DB instances | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| dbFlavorId | Body | UUID | X | Identifier of DB instance specifications
- Default: Source DB instance value | +| dbPort | Body | Integer | X | DB port
- Default: Source DB instance value
- Minimum value: `3306`
- Maximum value: `43306` | +| parameterGroupId | Body | UUID | X | Parameter group identifier
- Default: Source DB instance value | +======= | dbFlavorId | Body | UUID | X | Identifier of DB instance specifications | | dbPort | Body | Integer | X | DB port
- 기본값: 원본 DB 인스턴스 값
- Minimum value: `3306`
- Maximum value: `43306` | | parameterGroupId | Body | UUID | X | Parameter group identifier | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | dbSecurityGroupIds | Body | Array | X | DB security group identifiers ||network|Body|Object|O|Network information objects| | userGroupIds | Body | Array | X | User group identifiers | | useHighAvailability | Body | Boolean | X | Whether to use high availability
Default: `false` | @@ -3289,6 +3704,22 @@ POST /v4.0/backups/{backupId}/restore | useDefaultNotification | Body | Boolean | X | Whether to use default notification
Default: `false` | | useDeletionProtection | Body | Boolean | X | Whether to protect against deletion
Default: `false` | | useSlowQueryAnalysis | Body | Boolean | X | Whether to analyze slow queries
- Default: `true` | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| network | Body | Object | X | Network information objects | +| network.subnetId | Body | UUID | X | Subnet identifier
- Default: Source DB instance value | +| network.usePublicAccess | Body | Boolean | X | External access is available or not
Default: `false` | +| network.availabilityZone | Body | Enum | X | Availability zone where DB instance will be created
- e.g., `kr-pub-a`
- Default: Randomly selected | +| storage | Body | Object | X | Data storage information objects | +| storage.storageType | Body | Enum | X | Data storage type
- e.g., `General SSD`
- Default: Source DB instance value | +| storage.storageSize | Body | Number | X | Data storage size (GB)
- Default: Source DB instance value
- Minimum value: `20`
- Maximum value: `2048` | +| storage.storageAutoscale | Body | Object | X | Block Storage Auto Scaling Objects | +| storage.storageAutoscale.useStorageAutoscale | Body | Boolean | X | Storage autoscaling
- Default: Source DB instance value | +| storage.storageAutoscale.threshold | Body | Number | X | Auto scale conditions (%)
- Default: Source DB instance value
- Minimum value: `50`
- Maximum value: `95` | +| storage.storageAutoscale.maxStorageSize | Body | Number | X | Maximum auto scale size (GB)
- Default: Source DB instance value
- Maximum value: `4096` | +| storage.storageAutoscale.cooldownTime | Body | Number | X | Auto scale cooldown (min)
- Default: Source DB instance value
- Minimum value: `10`
- Maximum value: `1440` | +| backup | Body | Object | X | Backup information objects | +| backup.backupPeriod | Body | Number | X | Backup retention period (day)
- Default: Source DB instance value
- Minimum value: `0`
- Maximum value: `730` | +======= | network | Body | Object | X | Network information objects | | network.subnetId | Body | UUID | X | Subnet identifier | | network.usePublicAccess | Body | Boolean | X | External access is available or not
Default: `false` | @@ -3303,13 +3734,18 @@ POST /v4.0/backups/{backupId}/restore | storage.storageAutoscale.cooldownTime | Body | Number | X | Auto scaling cooldown time (minutes)
- 기본값: 원본 DB 인스턴스 값
- Minimum value: `10`
- Maximum value: `1440` | | backup | Body | Object | X | Backup information objects | | backup.backupPeriod | Body | Number | X | Backup retention period
- 기본값: 원본 DB 인스턴스 값
- Minimum value: `0`
- Maximum value: `730` | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | backup.ftwrlWaitTimeout | Body | Number | X | Query latency (sec)
Default: `6`
- Minimum value: `0`
- Maximum value: `21600` | | backup.backupRetryCount | Body | Number | X | Number of backup retries
Default: `6`
- Minimum value: `0`
- Maximum value: `10` | {{#if (eq engine.lowerCase "mysql")}} | backup.replicationRegion | Body | Enum | X | Backup replication region
- `KR1`: Korea (Pangyo) Region
- `KR2`: Korea (Pyeongchon) Region
- `JP1`: Japan (Tokyo) Region | {{/if}} | backup.useBackupLock | Body | Boolean | X | Whether to use table lock
Default: `true` | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| backup.backupSchedules | Body | Array | X | Scheduled auto backup list
- Default: Source DB instance value | +======= | backup.backupSchedules | Body | Array | X | Scheduled auto backup list | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup started time
- Example: `00:00:00` | | backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration
Auto backup proceeds within duration from backup start time.
- `HALF_AN_HOUR`: 30 minutes
- `ONE_HOUR`: 1 hour
- `ONE_HOUR_AND_HALF`: 1.5 hour
- `TWO_HOURS`: 2 hour
- `TWO_HOURS_AND_HALF`: 2.5 hour
- `THREE_HOURS`: 3 hour | @@ -3409,10 +3845,19 @@ GET /v4.0/db-security-groups This API does not require a request body. +<<<<<<< HEAD:template/en/api-guide-v4.0.md +| Name | Type | Format | Required | Description | +|-------------------|-------|----------|----|--------------------------------------------------------------------------------------------------------------------------------------| +| page | Query | Number | X | +Page to retrieve
- Default: 1
- Minimum value: `1` | +| size | Query | Number | X | Page size to retrieve
- Default: 20 | + +======= | 이름 | 종류 | 형식 | 필수 | 설명 | |-------------------|-------|----------|----|--------------------------------------------------------------------------------------------------------------------------------------| | page | Query | Number | X | 조회할 목록의 페이지
- 기본값: 1
- 최솟값: `1` | | size | Query | Number | X | 조회할 목록의 페이지 크기
- 기본값: 20 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md #### Response | Name | Type | Format | Description | @@ -4966,9 +5411,16 @@ GET /v4.0/events This API does not require a request body. | Name | Type | Format | Required | Description | +<<<<<<< HEAD:template/en/api-guide-v4.0.md +|-------------------|-------|----------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| page | Query | Number | X | Page to retrieve
- Default: 1
- Minimum value: `1` | +| size | Query | Number | X | +Page size to retrieve
- Default: 20 | +======= |-------------------|-------|----------|----|--------------------------------------------------------------------------------------------------------------------------------------| | page | Query | Number | X | 조회할 목록의 페이지
- 기본값: 1
- 최솟값: `1` | | size | Query | Number | X | 조회할 목록의 페이지 크기
- 기본값: 20 | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md | from | Query | Datetime | O | Start date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) | | to | Query | Datetime | O | End date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) | | eventCategoryType | Query | Enum | O | Event category types to query
ALL: All
- `INSTANCE`: DB instance
- `BACKUP`: Backup
- `DB_SECURITY_GROUP`: DB security group
- `TENANT`: Tenant | @@ -5084,14 +5536,59 @@ This API does not require a request body.

--- +<<<<<<< HEAD:template/en/api-guide-v4.0.md + +## Event Subscription + +### List Event Subscriptions +======= ## 이벤트 구독 ### 이벤트 구독 목록 조회 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md ```http GET /v4.0/event-subscriptions ``` +<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Required Permission + +| Permission | Description | +|---------------------------------------------------------|---------------| +| RDSfor{{engine.pascalCase}}:EventSubscription.List | List event subscriptions | + +#### Request + +| Name | Type | Format | Required | Description | +|-------------------|-------|----------|----|------------------------------------------| +| page | Query | Number | X | Page to retrieve
- Default: 1
- Minimum value: `1` | +| size | Query | Number | X | Page size to retrieve
- Default: 20 | +| eventSubscriptionId | Query | UUID | X | Event subscription identifier | +| eventSubscriptionName | Query | String | X | Name to identify event subscription | +| userGroupId | Query | UUID | X | User group identifier | + +#### Response + +| Name | Type | Format | Description | +|-----------------------------------------------|------|----------|--------------------------| +| totalCounts | Body | Number | Total number of event subscriptions | +| eventSubscriptions | Body | Array | List of event subscriptions | +| eventSubscriptions.eventSubscriptionId | Body | UUID | Event subscription identifier | +| eventSubscriptions.eventCategoryType | Body | Enum | Event category type | +| eventSubscriptions.eventSubscriptionName | Body | String | A name that identifies the event subscription | +| eventSubscriptions.enabled | Body | Boolean | Whether to activate | +| eventSubscriptions.notifyEmail | Body | Boolean | Whether to send emails | +| eventSubscriptions.notifySms | Body | Boolean | Whether to send SMS messages | +| eventSubscriptions.eventCodes | Body | Array | List of event codes to subscribe to | +| eventSubscriptions.sources | Body | Array | List of event sources to subscribe to | +| eventSubscriptions.sources.sourceId | Body | UUID | Identifier of the event source | +| eventSubscriptions.sources.eventCategoryType | Body | Enum | Event category type | +| eventSubscriptions.userGroupIds | Body | Array | List of identifiers of user groups subscribing to the event | +| eventSubscriptions.createdYmdt | Body | DateTime | Created at | + +
Example +======= #### 필요 권한 | 권한명 | 설명 | @@ -5129,6 +5626,7 @@ GET /v4.0/event-subscriptions | eventSubscriptions.createdYmdt | Body | DateTime | 생성 일시 |
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -5170,12 +5668,40 @@ GET /v4.0/event-subscriptions --- +<<<<<<< HEAD:template/en/api-guide-v4.0.md +### Create an Event Subscription +======= ### 이벤트 구독 생성하기 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md ```http POST /v4.0/event-subscriptions ``` +<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Required Permission + +| Permission | Description | +|----------------------------------------------------------|--------------| +| RDSfor{{engine.pascalCase}}:EventSubscription.Create | Create an event subscription | + +#### Request + +| Name | Type | Format | Required | Description | +|------------------------------|------|---------|----|-----------------------------------------| +| eventCategoryType | Body | Enum | O | Event category type | +| eventSubscriptionName | Body | String | O | A name that identifies the event subscription - maximum length: `100` | +| enabled | Body | Boolean | O | Whether to enable | +| notifyEmail | Body | Boolean | O | Whether to send emails | +| notifySms | Body | Boolean | O | Whether to send SMS messages | +| eventCodes | Body | Array | O | List of event codes to subscribe to | +| sources | Body | Array | O | List of event sources to subscribe to | +| sources.sourceId | Body | UUID | O | Identifier of the event source | +| sources.eventCategoryType | Body | Enum | O | Event category type | +| userGroupIds | Body | Array | O | List of identifiers of user groups to subscribe to | + +

Example +======= #### 필요 권한 | 권한명 | 설명 | @@ -5198,6 +5724,7 @@ POST /v4.0/event-subscriptions | userGroupIds | Body | Array | O | 이벤트 구독할 사용자 그룹의 식별자 목록 |
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -5225,6 +5752,15 @@ POST /v4.0/event-subscriptions

+<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Response + +| Name | Type | Format | Description | +|-----------------------|------|------|-------------| +| eventSubscriptionId | Body | UUID | Event subscription identifier | + +
Example +======= #### 응답 | 이름 | 종류 | 형식 | 설명 | @@ -5232,6 +5768,7 @@ POST /v4.0/event-subscriptions | eventSubscriptionId | Body | UUID | 이벤트 구독의 식별자 |
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -5250,12 +5787,41 @@ POST /v4.0/event-subscriptions --- +<<<<<<< HEAD:template/en/api-guide-v4.0.md +### Modify an Event Subscription +======= ### 이벤트 구독 수정하기 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md ```http PUT /v4.0/event-subscriptions/{eventSubscriptionId} ``` +<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Required Permission + +| Permission | Description | +|----------------------------------------------------------|--------------| +| RDSfor{{engine.pascalCase}}:EventSubscription.Modify | Modify an event subscription | + +#### Request + +| Name | Type | Format | Required | Description | +|------------------------------|------|---------|----|-----------------------------------| +| eventSubscriptionId | URL | UUID | O | Event subscription identifier | +| eventCategoryType | Body | Enum | X | Event category type | +| eventSubscriptionName | Body | String | X | A name that identifies the event subscription | +| enabled | Body | Boolean | X | Whether to enable | +| notifyEmail | Body | Boolean | X | Whether to send an email | +| notifySms | Body | Boolean | X | Whether to send an SMS | +| eventCodes | Body | Array | X | A list of event codes to subscribe to | +| sources | Body | Array | X | A list of event sources to subscribe to | +| sources.sourceId | Body | UUID | X | Event source identifier | +| sources.eventCategoryType | Body | Enum | X | Event category type | +| userGroupIds | Body | Array | X | A list of identifiers for user groups to subscribe to | + +

Example +======= #### 필요 권한 | 권한명 | 설명 | @@ -5279,6 +5845,7 @@ PUT /v4.0/event-subscriptions/{eventSubscriptionId} | userGroupIds | Body | Array | X | 이벤트 구독할 사용자 그룹의 식별자 목록 |
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -5307,11 +5874,19 @@ PUT /v4.0/event-subscriptions/{eventSubscriptionId}

+<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Response + +This API does not return a response body. + +
Example +======= #### 응답 이 API는 응답 본문을 반환하지 않습니다.
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -5329,12 +5904,35 @@ PUT /v4.0/event-subscriptions/{eventSubscriptionId} --- +<<<<<<< HEAD:template/en/api-guide-v4.0.md +### Delete an Event Subcription +======= ### 이벤트 구독 삭제하기 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md ```http DELETE /v4.0/event-subscriptions/{eventSubscriptionId} ``` +<<<<<<< HEAD:template/en/api-guide-v4.0.md +#### Required Permission + +| Permission | Description | +|----------------------------------------------------------|--------------| +| RDSfor{{engine.pascalCase}}:EventSubscription.Delete | Delete an event subscription | + +#### Request + +| Name | Type | Format | Required | Description | +|-----------------------|-----|------|----|-------------| +| eventSubscriptionId | URL | UUID | O | Event subscription identifier | + +#### Response + +This API does not return a response body. + +

Example +======= #### 필요 권한 | 권한명 | 설명 | @@ -5352,6 +5950,7 @@ DELETE /v4.0/event-subscriptions/{eventSubscriptionId} 이 API는 응답 본문을 반환하지 않습니다.
예시 +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md

```json @@ -5367,4 +5966,8 @@ DELETE /v4.0/event-subscriptions/{eventSubscriptionId}

+<<<<<<< HEAD:template/en/api-guide-v4.0.md +--- +======= --- +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md diff --git a/template/en/backup-and-restore_template.md b/template/en/backup-and-restore_template.md index 4716837a..36c84df6 100644 --- a/template/en/backup-and-restore_template.md +++ b/template/en/backup-and-restore_template.md @@ -107,6 +107,29 @@ When incremental backups are scheduled according to [Auto Backup Strategy](#Set- * A backup performed without table locks enabled cannot be a baseline backup. * If a new full backup was created after that backup was created, it cannot be the baseline backup. +<<<<<<< HEAD:template/en/backup-and-restore.md +## Snapshot Backup + +While existing backup methods can degrade performance when run directly on the DB instance, our **Storage Snapshot Backup** leverages Cinder snapshots—provided HA is active and healthy—to eliminate system overhead. +Because all heavy lifting—such as validation and file conversion—is offloaded to a separate server, your database maintains peak performance even during backups. + +Main Features +* Zero performance impact: DB instance performance is maintained at 100% even during backup operations. +* Enhanced reliability: Rigorous verification processes ensure the reliability of your backup data. +* Temporary High Availability (HA) suspension: HA features may be briefly paused during snapshot creation to ensure strict data consistency. + +### Pricing + +Unlike existing backup methods, Snapshot Backup incurs separate charges for the resources used during the backup process. + +| Category | Existing backup | Snapshot backup | +| --- | --- |---------------------------| +| Billing method | Included with DB instance (free of charge) | Additional charges apply for dedicated backup resources | +| Billable item | OBS upload fee (billed separately) | Shared backup server + volume + snapshot + OBS | + +* Shared backup server fee: This fee covers the use of backup servers for data validation and file conversion. + * Even when using shared resources, you are billed only for the actual time used during your backup operations. +======= ## 스냅숏 백업 기존 백업 방식은 백업 애플리케이션이 DB 인스턴스에서 실행되어 백업 중 성능 저하가 발생할 수 있었으나, **스토리지 스냅숏 백업**은 고가용성이 정상 상태로 활성화되어 있는 경우에 한해 Cinder 스토리지 스냅숏을 활용하여 백업을 수행합니다. @@ -128,6 +151,7 @@ When incremental backups are scheduled according to [Auto Backup Strategy](#Set- * 공용 백업 서버 요금: 백업 데이터의 검증 및 변환을 위해 사용하는 공용 백업 서버의 사용 요금입니다. * 공용 리소스를 사용하더라도 각 고객이 실제 사용한 시간에 대해 과금됩니다. +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/backup-and-restore_template.md ## Backup Settings diff --git a/template/en/db-engine_template.md b/template/en/db-engine_template.md index e2584fb7..d21d4038 100644 --- a/template/en/db-engine_template.md +++ b/template/en/db-engine_template.md @@ -8,8 +8,11 @@ In MySQL, the version number consists of version = `X.Y.Z.` In NHN Cloud's RDS f The versions specified below are available. New DB instance creation and read replicas are supported only for the top 7 minor versions per major version. Support for MySQL versions below 8.0.34 has ended in accordance with the MySQL LTS policy. We recommend upgrading your DB instances to the latest version. +<<<<<<< HEAD:template/en/db-engine.md +======= - Note: [https://blogs.oracle.com/mysql/introducing-mysql-innovation-and-longterm-support-lts-versions](https://blogs.oracle.com/mysql/introducing-mysql-innovation-and-longterm-support-lts-versions) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-engine_template.md | Version | Note | |----------------------|-----------------------------------------------------------| @@ -25,12 +28,21 @@ Support for MySQL versions below 8.0.34 has ended in accordance with the MySQL L | MySQL 8.0.40 | | | MySQL 8.0.36 | | | MySQL 8.0.35 | | +<<<<<<< HEAD:template/en/db-engine.md +| MySQL 8.0.34 | Creation and read replicas unsupported | +| MySQL 8.0.33 | Creation and read replicas unsupported | +| MySQL 8.0.32 | Creation and read replicas unsupported | +| MySQL 8.0.28 | Creation and read replicas unsupported | +| MySQL 8.0.23 | Creation and read replicas unsupported | +| MySQL 8.0.18 | Creation and read replicas unsupported | +======= | MySQL 8.0.34 | Creation and read replicas unsupported | | MySQL 8.0.33 | Creation and read replicas unsupported | | MySQL 8.0.32 | Creation and read replicas unsupported | | MySQL 8.0.28 | Creation and read replicas unsupported | | MySQL 8.0.23 | Creation and read replicas unsupported | | MySQL 8.0.18 | Creation and read replicas unsupported | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-engine_template.md | 5.7 | | | MySQL 5.7.37 | | | MySQL 5.7.33 | You cannot restore a DB instance from an external backup. | @@ -47,7 +59,11 @@ Support for MySQL versions below 8.0.34 has ended in accordance with the MySQL L After creating the DB instance, you can change the DB engine version and modify the DB instance. > [Caution] +<<<<<<< HEAD:template/en/db-engine.md +When attempting to change the DB version, only an upgrade is supported; a downgrade is not supported. +======= When attempting to change the DB version, only an upgrade is supported. a downgrade is not supported. +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-engine_template.md When upgrading the database engine version, a major version upgrade occurs if only the major version number is changed, and a minor version upgrade occurs if only the minor version number is changed. When attempting to upgrade the DB engine major version, you can upgrade to the next major version of the DB engine. diff --git a/template/en/db-instance_template.md b/template/en/db-instance_template.md index c50a32f6..c782a7a0 100644 --- a/template/en/db-instance_template.md +++ b/template/en/db-instance_template.md @@ -47,12 +47,21 @@ MySQL versions below 8.0.34 have reached End of Support per the MySQL LTS policy | MySQL 8.0.40 | | | MySQL 8.0.36 | | | MySQL 8.0.35 | | +<<<<<<< HEAD:template/en/db-instance.md +| MySQL 8.0.34 | Creation and read replicas unsupported | +| MySQL 8.0.33 | Creation and read replicas unsupported | +| MySQL 8.0.32 | Creation and read replicas unsupported | +| MySQL 8.0.28 | Creation and read replicas unsupported | +| MySQL 8.0.23 | Creation and read replicas unsupported | +| MySQL 8.0.18 | Creation and read replicas unsupported | +======= | MySQL 8.0.34 | Creation and read replicas unsupported | | MySQL 8.0.33 | Creation and read replicas unsupported | | MySQL 8.0.32 | Creation and read replicas unsupported | | MySQL 8.0.28 | Creation and read replicas unsupported | | MySQL 8.0.23 | Creation and read replicas unsupported | | MySQL 8.0.18 | Creation and read replicas unsupported | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md | 5.7 | | | MySQL 5.7.37 | | | MySQL 5.7.33 | You cannot restore a DB instance from an external backup. | @@ -157,6 +166,8 @@ You can set a maintenance duration when creating or modifying a DB instance. If > [Note] > A maintenance duration consists of a start day, a start time, and a duration (in 30-minute increments). +<<<<<<< HEAD:template/en/db-instance.md + #### Maintenance Task Maintenance tasks are categorized into User Maintenance and Provider Maintenance. @@ -187,6 +198,38 @@ You can choose when to apply maintenance tasks. You can check the maintenance status of each instance in the DB instance list. +======= +#### Maintenance Task + +Maintenance tasks are categorized into User Maintenance and Provider Maintenance. + +**User Maintenance Task** + +A task that users manually schedule and execute. + +* DB instance modifications (e.g., changing instance specs, port updates, parameter group changes) +* DB engine version upgrade +* DB instance OS upgrade + +**Provider Maintenance Task** + +A maintenance task provided by NHN Cloud. + +* Apply parameter group changes +* Migration for hypervisor maintenance + +#### Maintenance Execution Time + +You can choose when to apply maintenance tasks. + +* **Apply Immediately**: apply immediately upon request. +* **Apply in the Next Maintenance Duration**: apply during the next maintenance duration. + +#### Maintenance Status + +You can check the maintenance status of each instance in the DB instance list. + +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md | Status | Description | |---------|---------------------------------------| | None | There are no scheduled or pending maintenance tasks. | @@ -197,6 +240,8 @@ You can check the maintenance status of each instance in the DB instance list. > [Note] > The maintenance status is not displayed for the standby instance of High Availability (HA) DB instances. +<<<<<<< HEAD:template/en/db-instance.md + #### Maintenance Tab You can find the following information on the Maintenance tab of the DB instance details page: @@ -213,6 +258,24 @@ Upcoming maintenance tasks can be excluded from the maintenance duration using t All tasks within the maintenance duration are executed sequentially in the order they were registered. However, mandatory maintenance tasks that have expired will be prioritized and executed first. Any tasks not completed within the current duration will be rescheduled to the next maintenance duration. +======= +#### Maintenance Tab + +You can find the following information on the Maintenance tab of the DB instance details page: + +* Maintenance start day and duration +* Next maintenance duration +* Maintenance status +* Upcoming maintenance tasks (Scheduled for the next duration) +* Pending maintenance tasks + +Upcoming maintenance tasks can be excluded from the maintenance duration using the Hold or Delete buttons. For pending Provider maintenance tasks, you can manually apply them by selecting either **Apply Immediately** or **Apply in the Next Maintenance Duration**. + +#### Execution Order + +All tasks within the maintenance duration are executed sequentially in the order they were registered. However, mandatory maintenance tasks that have expired will be prioritized and executed first. Any tasks not completed within the current duration will be rescheduled to the next maintenance duration. + +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md > [Note] > If a maintenance task is repeatedly deferred because the maintenance duration starts while an automated backup is in progress or the DB instance is in a 'Busy' state, that task will be skipped and rescheduled for the next duration. An event will be generated if a maintenance task is skipped. @@ -239,7 +302,11 @@ If you activate deletion protection, you can protect DB instances from accidenta You can view DB instances created from the console. It can be viewed as groups of DB instances or as individual DB instances. +<<<<<<< HEAD:template/en/db-instance.md +![db-instance-list_en]({{url.cdn}}/26.01.13/db-instance-list_en.png) +======= ![db-instance-list_en]({{url.cdn}}/26.01.13/db-instance-detail_en.png) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md ❶ You can change DB instance screen mode. ❷ By clicking on the button, you can open or close a DB instance that belongs to a group. @@ -264,7 +331,7 @@ The status of the DB instance consists of the following values and changes depen Search conditions that can be changed are as follows. -![db-instance-filter_en]({{url.cdn}}/24.03.12/db-instance-filter_en.png) +![db-instance-filter_en]({{url.cdn}}/26.01.13/db-instance-filter_en.png) ❶ You can search for DB instances with filtering conditions that require parameter changes to be applied. @@ -272,7 +339,7 @@ Search conditions that can be changed are as follows. You can select a DB instance to view the details. -![db-instance-detail_en]({{url.cdn}}/24.03.12/db-instance-detail_en.png) +![db-instance-detail_en]({{url.cdn}}/26.01.13/db-instance-detail_en.png) ❶ When you click on the domain of the connection information, a pop-up window appears to confirm the IP address. ❷ When you click on DB Security Group, a pop-up window appears where you can check DB security rules. @@ -325,7 +392,7 @@ Click on **Download** to charge Internet traffic as the size of the log file. ❹ For binary logs, you can download them in two forms. Click on **Import** and you will see a pop-up window where you can select the type of binary log. -![db-instance-detail-log-bin_en]({{url.cdn}}/24.03.12/db-instance-detail-log-bin_en.png) +![db-instance-detail-log-bin_en]({{url.cdn}}/26.01.13/db-instance-detail-log-bin_en.png) ❺ Select to use the mysqlbinlog utility to convert the binary log into SQL file and then download it. @@ -333,7 +400,11 @@ Click on **Download** to charge Internet traffic as the size of the log file. The Maintenance tab allows you to monitor settings and status, and manage maintenance operations for your DB instance. +<<<<<<< HEAD:template/en/db-instance.md +![db-instance-detail-maintenance_ko]({{url.cdn}}/26.01.13/db-instance-detail-maintenance_ko.png) +======= ![db-instance-detail-maintenance_en]({{url.cdn}}/26.01.13/db-instance-detail-maintenance_en.png) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md #### Maintenance Information @@ -348,10 +419,18 @@ At the top of the Maintenance tab, you can view the maintenance configuration de > [Note] > Even if you haven't set a maintenance duration, you can view the randomly assigned duration here. +<<<<<<< HEAD:template/en/db-instance.md + #### Upcoming Maintenance Upcoming Maintenance is a list of tasks scheduled to be executed during the next maintenance duration. When you perform actions such as modifying a DB instance or upgrading the DB engine version and select **Apply in the Next Maintenance Duration**, the task is added to this list. +======= +#### Upcoming Maintenance + +Upcoming Maintenance is a list of tasks scheduled to be executed during the next maintenance duration. When you perform actions such as modifying a DB instance or upgrading the DB engine version and select **Apply in the Next Maintenance Duration**, the task is added to this list. + +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md | Item | Description | |------------|----------------------------------| | Description | A description of the maintenance task. | @@ -369,17 +448,36 @@ Provider maintenance tasks will be moved to the Pending Maintenance list. You ca Pending Maintenance is a list of Provider maintenance tasks provided by NHN Cloud. This includes operations such as applying parameter group changes and migrations for hypervisor maintenance. +<<<<<<< HEAD:template/en/db-instance.md +| Item | Description | +|------------|----------------------------------| +| Description | A description of the maintenance task. | +| Type | The type of maintenance task. | +| Status | The current status of the maintenance task. | +| Mandatory | Indicates whether the maintenance task is mandatory. | +======= | Item | Description | |-------------|-----------------------------------------------------------------------------| | Description | A description of the maintenance task. | | Type | The type of maintenance task. | | Status | The current status of the maintenance task. | | Mandatory | Indicates whether the maintenance task is mandatory. | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md | Forced Date | If the task is mandatory, it will be applied automatically after this date. | You can select a pending maintenance task and then click **Next** to select the execution time. **Apply Immediately**: apply immediately upon request. Click **Confirm** to execute immediately. +<<<<<<< HEAD:template/en/db-instance.md +![db-instance-detail-maintenance-immediately_ko]({{url.cdn}}/26.01.13/db-instance-detail-maintenance-immediately_ko.png) + +**Apply in the Next Maintenance Duration**: apply during the next maintenance duration. Click **Confirm** to move this task to the Upcoming Maintenance list. +![db-instance-detail-maintenance-schedule_ko]({{url.cdn}}/26.01.13/db-instance-detail-maintenance-schedule_ko.png) + +> [Caution] +> Required maintenance tasks can be applied at any time up to the mandatory application date. However, after the mandatory application date, they will automatically be performed during the next maintenance period. + +======= ![db-instance-detail-maintenance-immediately_en]({{url.cdn}}/26.01.13/db-instance-detail-maintenance-immediately_en.png) **Apply in the Next Maintenance Duration**: apply during the next maintenance duration. Click **Confirm** to move this task to the Upcoming Maintenance list. @@ -387,6 +485,7 @@ You can select a pending maintenance task and then click **Next** to select the > [Caution] > Required maintenance tasks can be applied at any time up to the mandatory application date. However, after the mandatory application date, they will automatically be performed during the next maintenance period. +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md > [Note] > If a maintenance task requires a restart, a pop-up screen will appear, allowing you to select additional options, such as failover or backup. For high-availability DB instances, you can minimize service downtime by using a restart with failover. @@ -417,7 +516,11 @@ You cannot modify the name of the DB schema that has been created. #### Create a user +<<<<<<< HEAD:template/en/db-instance.md +![db-instance-detail-user-create-en]({{url.cdn}}/26.01.13/db-instance-detail-user-create-en.png) +======= ![db-instance-detail-user-create-en]({{url.cdn}}/26.01.13/db-instance-detail-user-create-en.png)) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md ❶ Click on **+Create** and you'll see the Add User pop-up window. ❷ Enter a user ID. @@ -466,7 +569,11 @@ GRANT EXECUTE ON `mysql`.* TO '{user_id}'@'{host}'; | Authentication Plugin | Supported Versions | |-----------------------|-----------------------------------------------| +<<<<<<< HEAD:template/en/db-instance.md +| mysql_native_password | 8.4 version or below | +======= | mysql_native_password | 8.4 version or below | +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md | sha256_password | 5.7.33 version or later and below 8.0 version | | caching_sha2_password | 8.0 version or later | @@ -486,7 +593,11 @@ User authentication plug-ins and TLS options are supported in MySQL 5.7.33 and l If you set TLS option for your account to X509, you need a certificate to access the DB instance. ![db-instance-detail-user-cert-en]({{url.cdn}}/26.01.13/db-instance-detail-user-cert-en.png) +<<<<<<< HEAD:template/en/db-instance.md +![db-instance-detail-user-cert-down-en]({{url.cdn}}/26.01.13/db-instance-detail-user-cert-down-en.png) +======= ![db-instance-detail-user-cert-down-en]({{url.cdn}}/24.03.12/db-instance-detail-user-cert-down-en.png) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md ❶ Select the DB instance to which you want to download the certificate. ❷ Click on drop-down menu. @@ -541,7 +652,10 @@ For high-availability DB instances, if there are any changes to items that need ![modify-ha-popup-en]({{url.cdn}}/26.01.13/modify-ha-popup-en.png) +<<<<<<< HEAD:template/en/db-instance.md +======= +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md ❶ Modify your DB instance and schedule the update by selecting either **Apply in the Next Maintenance Duration** or **Apply Immediately**. ❷ If you do not use 'Reboot with Failover', changes will be applied sequentially to the master and standby instances, followed by a restart of the DB instance. For more details, please refer to the [Manual Failover section](db-instance/#manual-failover) for High Availability DB instances. @@ -572,7 +686,11 @@ Operating system version upgrades behave differently depending on whether you ar When you click the OS Version Upgrade button for a single DB instance, the following pop-up screen appears. The maintenance feature is also available when upgrading the operating system version of a single DB instance. +<<<<<<< HEAD:template/en/db-instance.md +![db-instance-os-upgrade-single-popup-en.png]({{url.cdn}}/24.06.11/db-instance-os-upgrade-simple-popup-en.png) +======= ![db-instance-os-upgrade-single-popup-en.png]({{url.cdn}}/26.01.13/db-instance-os-upgrade-simple-popup-en.png) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md When you click the Upgrade Operating System Version for High Availability DB Instance button, the pop-up screen shown below appears. For more information, see [Manual failover item](db-instance/#manual-failover) of High Availability DB Instances. ![os-upgrade-ha-popup-en.png]({{url.cdn}}/26.01.13/os-upgrade-ha-popup-en.png) @@ -799,7 +917,7 @@ Enabling Delete Protection protects DB instances from being accidentally deleted ❶ If you select the DB instance for which you want to change the Deletion Protection settings and click on **Change Deletion Protection Settings** menu from the drop-down menu, a pop-up window will appear. -![deletion-protection-popup-en]({{url.cdn}}/24.03.12/deletion-protection-popup-en.png) +![deletion-protection-popup-en]({{url.cdn}}/26.01.13/deletion-protection-popup-en.png) ❷ Change the Delete Protection settings and click on **Confirm**. @@ -933,10 +1051,62 @@ High availability features can be temporarily stopped in situations where a temp Candidate master replication can be disrupted due to a variety of reasons, such as network disconnection, incorrect FEDERATED engine use, and replication settings from other masters. Candidate masters in a Stopped Replication state do not perform automatic failover. To resolve a backup master's Stopped Replication, the candidate master needs to be rebuilt. When rebuilding a candidate master, it removes all of the candidate master's databases and rebuilds them based on the master's database. In this process, if the backup file required for rebuilding does not exist in the master database, the backup is performed on the master, which can cause performance degradation. +<<<<<<< HEAD:template/en/db-instance.md +{{#if (eq engine.lowerCase "mysql")}} + +## DB Cluster + +A DB cluster is a DB instance group type that provides high availability and enhanced backup performance. + +### DB Cluster Characteristics + +DB clusters have the following characteristics: + +#### High Availability Configuration + +DB clusters are configured for high availability by default. The master and standby masters are created in different availability zones, providing fault-tolerant databases. + +#### GTID-Based Replication + +DB clusters use GTID (global transaction identifier)-based replication. The following parameters are mandatory and cannot be changed. + +* `gtid_mode = ON` +* `enforce_gtid_consistency = ON` +* `binlog_format = ROW` + +> [Caution] Some replication-related procedures are restricted due to GTID mode. For more information, see [{{engine.pascalCase}} Procedure](#{{engine.lowerCase}}-procedure). + +#### Improved Backup Performance + +DB clusters provide improved backup capabilities. + +* **Resource Savings**: Saves DB instance resources by up to 99% during backups. +* **Reduced Backup Time**: Reduces overall backup time by over 90% compared to previous versions. + +> [Note] +> In some cases, under heavy load on the DB instance, performance degradation due to backups may occur, as before. + +> [Note] Existing DB instance groups cannot be migrated to DB clusters. If necessary, please contact Customer Support. + +#### DB Cluster-Dedicated Parameter Group + +DB clusters use dedicated parameter groups. GTID-related parameters are preset in these parameter groups; some cannot be modified. + +{{/if}} + +======= +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md ## {{engine.pascalCase}} Procedure RDS for {{engine.pascalCase}} provides its own procedures for performing some of the features that are restricted from user accounts to provide user convenience. +<<<<<<< HEAD:template/en/db-instance.md +{{#if (eq engine.lowerCase "mysql")}} +> [Caution] If the DB instance group is of DB cluster type, the use of replication-related procedures (tcrds_repl_*) is restricted. +{{/if}} + +======= +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md ### tcrds_active_process * Make inquiry of Process list for ACTIVE status, not Sleep status. @@ -966,7 +1136,11 @@ RDS for {{engine.pascalCase}} provides its own procedures for performing some of {{engine.lowerCase}}> CALL mysql.tcrds_current_lock(); ``` +<<<<<<< HEAD:template/en/db-instance.md +### tcrds_repl_changemaster (prior to 8.4) +======= ### tcrds_repl_changemaster (prior to 8.4) +>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/db-instance_template.md * Used to import external {{engine.pascalCase}} DBs into NHN Cloud RDS using replication. * Replication configuration of NHN Cloud RDS is done with **Create replication** of the console.