@@ -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
+ +```json +{ + "header": { + "resultCode": 0, + "resultMessage": "SUCCESS", + "isSuccessful": true + }, + "binLogs": [ + { + "binLogFileName": "mysql-bin.000001", + "binLogFileSize": 1073741824, + "createdYmdt": "2023-03-17T14:02:29+09:00" + } + ] +} +``` + +
++ +```json +{ + "lastBinLogFileName": "mysql-bin.000010" +} +``` + +
++ +```json +{ + "header": { + "resultCode": 0, + "resultMessage": "SUCCESS", + "isSuccessful": true + } +} +``` + +
++ +```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" + } + ] +} +``` + +
++ +```json +{ + "certificateTypes": ["CA_FILE", "CERT_FILE", "KEY_FILE"], + "tenantId": "399631c404744dbbb18ce4fa2dc71a5a", + "username": "gildong.hong@nhn.com", + "password": "password", + "targetContainer": "container", + "objectPath": "certificates/" +} +``` + +
+
```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
```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.
```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 |
+
+
```json
@@ -5225,6 +5752,15 @@ POST /v4.0/event-subscriptions
```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 |
+
+
```json
@@ -5307,11 +5874,19 @@ PUT /v4.0/event-subscriptions/{eventSubscriptionId}
```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.
+
+
```json
@@ -5367,4 +5966,8 @@ DELETE /v4.0/event-subscriptions/{eventSubscriptionId}
Example
+=======
#### 필요 권한
| 권한명 | 설명 |
@@ -5198,6 +5724,7 @@ POST /v4.0/event-subscriptions
| userGroupIds | Body | Array | O | 이벤트 구독할 사용자 그룹의 식별자 목록 |
예시
+>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md
Example
+=======
#### 응답
| 이름 | 종류 | 형식 | 설명 |
@@ -5232,6 +5768,7 @@ POST /v4.0/event-subscriptions
| eventSubscriptionId | Body | UUID | 이벤트 구독의 식별자 |
예시
+>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md
Example
+=======
#### 필요 권한
| 권한명 | 설명 |
@@ -5279,6 +5845,7 @@ PUT /v4.0/event-subscriptions/{eventSubscriptionId}
| userGroupIds | Body | Array | X | 이벤트 구독할 사용자 그룹의 식별자 목록 |
예시
+>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md
Example
+=======
#### 응답
이 API는 응답 본문을 반환하지 않습니다.
예시
+>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md
Example
+=======
#### 필요 권한
| 권한명 | 설명 |
@@ -5352,6 +5950,7 @@ DELETE /v4.0/event-subscriptions/{eventSubscriptionId}
이 API는 응답 본문을 반환하지 않습니다.
예시
+>>>>>>> 9ffa70b7eea85651d3e1a6f14fa27f835b88e3c0:template/en/api-guide-v4.0_template.md