Region | Endpoint |
---|---|
Korea (Pangyo) region | https://kr1-rds-postgres.api.nhncloudservice.com |
To use the API, you need a token of type Bearer, issued through Public API > API Calls and Authentication. The issued token must be included in the request header along with the Appkey.
Name | Type | Format | Required | Description |
---|---|---|---|---|
X-TC-APP-KEY | Header | String | O | Appkey or project integration appkey for RDS for PostgreSQL service |
X-NHN-AUTHORIZATION | Header | String | O | Bearer type token issued with the Public API |
Project permissions also limit the APIs that can be called. The RDS for
PostgreSQL
ADMIN
and RDS for PostgreSQL VIEWER
roles are granted default permissions, as shown below, and you can grant only the permissions you need from the Manage Role Groups menu within the project.
RDS for PostgreSQL ADMIN
role is granted all the permissions required to run the API.RDS for PostgreSQL VIEWER
role is granted with the permission to view information only.If an API request fails to authenticate or is not authorized, the following error occurs.
resultCode | resultMessage | Description |
---|---|---|
80401 | Unauthorized | Failed to authenticate |
80403 | Forbidden | Unauthorized. |
The API responds with "200 OK" to all API requests. For more information on the response results, see Response Body Header.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
Name | Data type | Description |
---|---|---|
resultCode | Number | Result code (Success: 0, Other: Failure) |
resultMessage | String | Result message |
successful | Boolean | Successful or not |
DB version | Available for creation |
---|---|
POSTGRESQL_V146 | O |
GET /v1.0/db-versions
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbVersion.List | View DB Version List |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
dbVersions | Body | Array | DB version list |
dbVersions.dbVersion | Body | String | DB version |
dbVersions.dbVersionName | Body | String | DB version name |
dbVersions.restorableFromObs | Body | Boolean | Restoring backup from object storage available or not |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbVersions": [
{
"dbVersion": "POSTGRESQL_V146",
"dbVersionName": "PostgreSQL V14.6",
"restorableFromObs": true
}
]
}
GET /v1.0/db-flavors
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbFlavor.List | List DB Instance Specifications |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
dbFlavors | Body | Array | List of DB instance specifications |
dbFlavors.dbFlavorId | Body | UUID | Identifier of DB instance specifications |
dbFlavors.dbFlavorName | Body | String | Name of DB instance specifications |
dbFlavors.ram | Body | Number | Memory size (MB) |
dbFlavors.vcpus | Body | Number | CPU cores |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbFlavors": [
{
"dbFlavorId": "50be6d9c-02d6-4594-a2d4-12010eb65ec0",
"dbFlavorName": "m2.c1m2",
"ram": 2048,
"vcpus": 1
}
]
}
GET /v1.0/project/regions
Permission Name | Description |
---|---|
RDSforPostgreSQL:Project.Get | Get project information |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
regions | Body | Array | Region list |
regions.regionCode | Body | Enum | Region codeKR1 : Korea (Pangyo) Region |
regions.isEnabled | Body | Boolean | Whether to enable a region |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"regions": [
{
"regionCode": "KR1",
"isEnabled": true
}
]
}
GET /v1.0/project/members
Permission Name | Description |
---|---|
RDSforPostgreSQL:Project.Get | Get project information |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
members | Body | Array | Project member list |
members.memberId | Body | UUID | Project member identifier |
members.memberName | Body | String | Project member name |
members.emailAddress | Body | String | Project member email address |
members.phoneNumber | Body | String | Project member mobile |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"members": [
{
"memberId": "1b1d3627-507a-49ea-8cb7-c86dfa9caa58",
"memberName": "Hong Gildong",
"emailAddress": "gildong.hong@nhn.com",
"phoneNumber": "+821012345678"
}
]
}
GET /v1.0/network/subnets
Permission Name | Description |
---|---|
RDSforPostgreSQL:Network.List | List Subnets |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
subnets | Body | Array | Subnet list |
subnets.subnetId | Body | UUID | Subnet identifier |
subnets.subnetName | Body | String | Name to identify subnets |
subnets.subnetCidr | Body | String | CIDR of subnet |
subnets.usingGateway | Body | Boolean | Whether to use gateway |
subnets.availableIpCount | Body | Number | Number of available IPs |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"subnets": [
{
"subnetId": "1b2a9b23-0725-4b92-8c78-35db66b8ad9f",
"subnetName": "Default Network",
"subnetCidr": "192.168.0.0/24",
"usingGateway": true,
"availableIpCount": 240
}
]
}
GET /v1.0/storage-types
Permission Name | Description |
---|---|
RDSforPostgreSQL:Storage.List | View the list of storage types |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
storageTypes | Body | Array | List of storage types |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"storageTypes": [
"General SSD",
"General HDD"
]
}
GET /v3.0/jobs/{jobId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:Job.Get | List Task Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
jobId | URL | UUID | O | Task identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Task identifier |
jobStatus | Body | Enum | Current task status - PREPARING : If the task is being prepared- READY : When the task is ready- RUNNING : If the task is in progress- COMPLETED : When the task is complete- REGISTERED : If the task is registered- WAIT_TO_REGISTER : If the job is waiting to be registered- INTERRUPTED : If an interrupt occurred while the operation was in progress.- CANCELED : If the task is canceled- FAILED : If the operation failed- ERROR : If an error occurred while the operation was in progress- DELETED : If the task has been deleted- FAIL_TO_READY : The job failed to be ready. |
resourceRelations | Body | Array | Relevant resource list |
resourceRelations.resourceType | Body | Enum | Relevant resource type - DB_INSTANCE : DB instance- DB_INSTANCE_GROUP : DB instance group- DB_SECURITY_GROUP : DB security group- PARAMETER_GROUP : Parameter Group- BACKUP : Backup- TENANT : Tenant |
resourceRelations.resourceId | Body | UUID | Relevant resource identifier |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c",
"jobStatus": "RUNNING",
"resourceRelations": [
{
"resourceType": "DB_INSTANCE",
"resourceId": "56b39dcf-65eb-47ec-9d4f-09f160ba2266"
}
],
"createdYmdt": "2023-02-22T20:47:12+09:00",
"updatedYmdt": "2023-02-22T20:49:46+09:00"
}
GET /v1.0/db-instance-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceGroup.List | List DB Instances |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
dbInstanceGroups | Body | Array | DB instance groups |
dbInstanceGroups.dbInstanceGroupId | Body | UUID | DB instance group identifier |
dbInstanceGroups.dbInstanceGroupStatus | Body | Enum | Current status of DB instance groups - CREATED: Created - DELETED : Deleted |
dbInstanceGroups.replicationType | Body | Enum | DB instance group replication type - STANDALONE : Standalone |
dbInstanceGroups.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
dbInstanceGroups.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbInstanceGroups": [
{
"dbInstanceGroupId": "05de0746-89fd-49c8-94f9-9c5b1df97009",
"dbInstanceGroupStatus": "CREATED",
"replicationType": "STANDALONE",
"createdYmdt": "2023-02-13T17:35:20+09:00",
"updatedYmdt": "2023-02-13T17:35:20+09:00"
}
]
}
GET /v1.0/db-instance-groups/{dbInstanceGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceGroup.Get | List DB Instance Group Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceGroupId | URL | UUID | O | DB instance group identifier |
Name | Type | Format | Description |
---|---|---|---|
dbInstanceGroupId | Body | UUID | DB instance group identifier |
dbInstanceGroupStatus | Body | Enum | Current status of DB instance groups - CREATED: Created - DELETED : Deleted |
replicationType | Body | Enum | DB instance group replication type - STANDALONE : Standalone- HIGH_AVAILABILITY : High availability |
dbInstances | Body | Array | DB instances belong to DB instance group |
dbInstances.dbInstanceId | Body | UUID | DB instance identifier |
dbInstances.dbInstanceType | Body | Enum | DB instance role type - MASTER : Master- FAILED_MASTER : Failed over master- CANDIDATE_MASTER : Candidate master- READ_ONLY_SLAVE : Read replica |
dbInstances.dbInstanceStatus | Body | Enum | DB instance current status |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbInstanceGroupId": "36617a8e-0df8-4b16-b6ea-6306019e95da",
"dbInstanceGroupStatus": "CREATED",
"replicationType": "STANDALONE",
"dbInstances": [
{
"dbInstanceId": "6d2db0ef-fe9b-4ed4-97b1-d97fcb4cf1b8",
"dbInstanceType": "MASTER",
"dbInstanceStatus": "AVAILABLE"
}
],
"createdYmdt": "2023-03-03T17:38:14+09:00",
"updatedYmdt": "2023-03-03T17:38:14+09:00"
}
Status | Description |
---|---|
AVAILABLE |
DB instance is available |
BEFORE_CREATE |
Before creating a DB instance |
STORAGE_FULL |
Insufficient DB instance storage |
FAIL_TO_CREATE |
Failed to create DB instance |
FAIL_TO_CONNECT |
Failed to connect DB instance |
REPLICATION_STOP |
Replication of DB instance is stopped |
REPLICATION_DELAY |
When replication of a DB instance is delayed |
FAILOVER |
When failover of a highly available DB instance is complete |
SHUTDOWN |
DB instance is stopped |
DELETED |
DB instance is deleted |
Status | Description |
---|---|
APPLYING_DB_INSTANCE_HBA_RULE |
Applying an access control rule |
APPLYING_PARAMETER_GROUP |
Parameter group is being applied |
BACKING_UP |
Backing up |
CANCELING |
Canceling |
CREATING |
Creating |
CREATING_DATABASE |
Creating a database |
CREATING_USER |
Creating user |
DELETING |
Deleting |
DELETING_DATABASE |
Deleting a database |
DELETING_USER |
Deleting user |
FAILING_OVER |
Under failover |
MIGRATING |
Under migration |
MODIFYING |
Under modification |
OCCUPIED |
Occupied |
PREPARING |
In preparation |
PROMOTING |
Promoting |
PROMOTING_FORCIBLY |
Force Promoting |
REBUILDING |
Rebuilding |
REPAIRING |
Recovering |
REPLICATING |
Replicating |
RESTARTING |
Restarting |
RESTARTING_FORCIBLY |
Force restarting |
RESTORING |
Restoring |
STARTING |
Starting |
STOPPING |
Stopping |
SYNCING_DATABASE |
Synchronizing the database |
SYNCING_USER |
Synchronizing user |
UPDATING_USER |
Modifying user |
UPDATING_DATABASE |
Modifying the database |
WAIT_MANUAL_CONTROL |
Waiting for manual failover |
GET /v1.0/db-instances
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.List | List DB instances |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
dbInstances | Body | Array | DB instances |
dbInstances.dbInstanceId | Body | UUID | DB instance identifier |
dbInstances.dbInstanceGroupId | Body | UUID | DB instance group identifier |
dbInstances.dbInstanceName | Body | String | Name to identify DB instances |
dbInstances.description | Body | String | Additional information on DB instances |
dbInstances.dbVersion | Body | Enum | DB version information |
dbInstances.dbPort | Body | Number | DB port |
dbInstances.dbInstanceType | Body | Enum | DB instance role type - MASTER : Master- FAILED_MASTER : Failed over master- CANDIDATE_MASTER : Candidate master- READ_ONLY_SLAVE : Read replica |
dbInstances.dbInstanceStatus | Body | Enum | DB instance current status |
dbInstances.progressStatus | Body | Enum | DB instance current status |
dbInstances.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
dbInstances.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbInstances": [
{
"dbInstanceId": "d067593b-1acc-4ccc-9e8a-cc72d6d79ec3",
"dbInstanceGroupId": "51c7d080-ff36-4025-84b1-9d9d0b4fe9e0",
"dbInstanceName": "db-instance",
"description": null,
"dbVersion": "POSTGRESQL_V146",
"dbPort": 15432,
"dbInstanceType": "MASTER",
"dbInstanceStatus": "AVAILABLE",
"progressStatus": "NONE",
"createdYmdt": "2023-01-23T12:03:13+09:00",
"updatedYmdt": "2023-02-02T17:20:17+09:00"
}
]
}
GET /v1.0/db-instances/{dbInstanceId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
dbInstanceId | Body | UUID | DB instance identifier |
dbInstanceGroupId | Body | UUID | DB instance group identifier |
dbInstanceName | Body | String | Name to identify DB instances |
description | Body | String | Additional information on DB instances |
dbVersion | Body | Enum | DB version information |
dbPort | Body | Number | DB port |
dbInstanceType | Body | Enum | DB instance role type - MASTER : Master- FAILED_MASTER : Failed over master- CANDIDATE_MASTER : Candidate master- READ_ONLY_SLAVE : Read replica |
dbInstanceStatus | Body | Enum | DB instance current status |
progressStatus | Body | Enum | Current task status of DB instance |
dbFlavorId | Body | UUID | Identifier of DB instance specifications |
parameterGroupId | Body | UUID | Parameter group identifier applied to DB instance |
dbSecurityGroupIds | Body | Array | DB security group identifiers applied to DB instance |
notificationGroupIds | Body | Array | List of identifiers of notification groups applied to the DB instance |
useDeletionProtection | Body | Boolean | Whether to protect DB instance against deletion |
needToApplyParameterGroup | Body | Boolean | Need to apply the latest parameter group |
needMigration | Body | Boolean | Need to migrate |
osVersion | Body | String | OS Version |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbInstanceId": "d067593b-1acc-4ccc-9e8a-cc72d6d79ec3",
"dbInstanceGroupId": "51c7d080-ff36-4025-84b1-9d9d0b4fe9e0",
"dbInstanceName": "db-instance",
"description": null,
"dbVersion": "POSTGRESQL_V146",
"dbPort": 15432,
"dbInstanceType": "MASTER",
"dbInstanceStatus": "AVAILABLE",
"progressStatus": "NONE",
"dbFlavorId": "e9ed4ef6-78d7-46fa-ace9-32481e97f3b7",
"parameterGroupId": "b03e8b13-de27-4d04-a488-ff5689589372",
"dbSecurityGroupIds": ["01908c35-d2c9-4852-baf0-17f06ec42c03"],
"notificationGroupIds": ["83a62a33-ddbf-4a04-8653-e54463d5b1ac"],
"useDeletionProtection": false,
"needToApplyParameterGroup": false,
"needMigration": false,
"createdYmdt": "2022-11-23T12:03:13+09:00",
"updatedYmdt": "2022-12-02T17:20:17+09:00"
}
POST /v1.0/db-instances
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Create | Create DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceName | Body | String | O | Name to identify DB instances |
description | Body | String | X | Additional information on DB instances |
dbFlavorId | Body | UUID | O | Identifier of DB instance specifications |
dbVersion | Body | Enum | O | DB version information |
dbPort | Body | Number | O | DB port - Minimum value: 0 - Maximum value: 65535 |
databaseName | Body | String | O | Name of the new database to create in the DB Engine |
dbUserName | Body | String | O | New user account name to create in DB Engine |
dbPassword | Body | String | O | Password for the new user account to be created in the DB Engine - Minimum length: 4 - Maximum length: 16 |
parameterGroupId | Body | UUID | O | Parameter group identifier |
dbSecurityGroupIds | Body | Array | X | DB security group identifiers |
useDeletionProtection | Body | Boolean | X | Whether to protect against deletion Default: false |
useDefaultNotification | Body | Boolean | X | Whether to use default notification Default: false |
useHighAvailability | Body | Boolean | X | Whether to use high availability |
pingInterval | Body | Number | X | Ping interval (sec) when using high availability - Minimum value: 1 - Maximum value: 600 |
failoverReplWaitingTime | Body | Number | X | Failover latency when using high availability - Minimum value: 0 - If set to -1, it will continue to wait for the replication delay to resolve. |
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 | X | Availability zone where DB instance will be created - Example: kr-pub-a - Default: Any availability zone |
storage | Body | Object | O | Storage information objects |
storage.storageType | Body | Enum | O | Data storage types - 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.backupRetryCount | Body | Number | X | Number of backup retries Default: 6 - Minimum value: 0 - Maximum value: 10 |
backup.backupSchedules | Body | Array | X | Backup schedules |
backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup Start Time - Example: 00:00:00 |
backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup Window Auto backup is executed within the set duration from the 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 |
{
"dbInstanceName": "db-instance",
"description": "description",
"dbFlavorId": "71f69bf9-3c01-4c1a-b135-bb75e93f6268",
"dbVersion": "POSTGRESQL_V146",
"dbPort": 15432,
"databaseName": "database",
"dbUserName": "db-user",
"dbPassword": "password",
"parameterGroupId": "488bf4f5-d8f7-459b-ace6-529b606c8570",
"dbSecurityGroupIds": [
"b0483a3d-e8e2-46f6-9e84-d5e31b0d44f4"
],
"userGroupIds": [],
"network": {
"subnetId": "e721a9dd-dad0-4cf0-a53b-dd654ebfc683",
"availabilityZone": "kr-pub-a"
},
"storage": {
"storageType": "General SSD",
"storageSize": 20
},
"backup": {
"backupPeriod": 1,
"backupSchedules": [
{
"backupWndBgnTime": "00:00:00",
"backupWndDuration": "ONE_HOUR_AND_HALF",
"backupRetryExpireTime": "01:30:00"
}
]
}
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
PUT /v1.0/db-instances/{dbInstanceId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
dbInstanceName | Body | String | X | Name to identify DB instances |
description | Body | String | X | Additional information on DB instances |
dbPort | Body | Number | X | DB port - Minimum value: 0 - Maximum value: 65535 |
dbFlavorId | Body | UUID | X | Identifier of DB instance specifications |
parameterGroupId | Body | UUID | X | Parameter group identifier |
dbSecurityGroupIds | Body | Array | X | DB security group identifiers |
executeBackup | Body | Boolean | X | Whether to execute backup at this time Default: false |
{
"dbInstanceName": "db-instance2",
"description": "description2",
"dbPort": 10001,
"dbSecurityGroupIds": [],
"executeBackup": true
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/high-availability
Permission Name | Description |
---|---|
RDSforPostgreSQL:HighAvailability.Get | Get high availability information |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
haStatus | Body | Boolean | High Availability Status - CREATED: Created - STABLE : Normal- DISABLE_REPLICATION_DELAY : Failover stops due to replication delay- PAUSING : Pausing- PAUSED : Paused- PAUSED_DUE_TO_TASK : Paused due to task - FAILOVER_STARTED : Failover started- FAILOVER_FAILED : Failover failed- FAILOVER_COMPLETED : Failover complete- DELETED : Deleted |
pingInterval | Body | Number | Ping interval (sec) when using high availability - Minimum value: 1 - Maximum value: 600 |
failoverReplWaitingTime | Body | Number | Failover latency when using high availability - Minimum value: 0 - If set to -1, it will continue to wait for the replication delay to resolve. |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"useHighAvailability": true,
"haStatus": "STABLE",
"pingInterval": 3,
"failoverReplWaitingTime": 60
}
PUT /v1.0/db-instances/{dbInstanceId}/high-availability
Permission Name | Description |
---|---|
RDSforPostgreSQL:HighAvailability.Modify | Modify High Availability |
Name | Type | Format | Required | Description |
---|---|---|---|---|
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 |
failoverReplWaitingTime | Body | Number | X | Failover latency when using high availability - Minimum value: 0 - If set to -1, it will continue to wait for the replication delay to resolve. |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/high-availability/resume
Permission Name | Description |
---|---|
RDSforPostgreSQL:HighAvailability.Resume | Restart High Availability |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/high-availability/pause
Permission Name | Description |
---|---|
RDSforPostgreSQL:HighAvailability.Pause | Pause High Availability |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/high-availability/repair
Permission Name | Description |
---|---|
RDSforPostgreSQL:HighAvailability.Repair | Recover High Availability |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/high-availability/split
Permission Name | Description |
---|---|
RDSforPostgreSQL:HighAvailability.Split | Separate High Availability |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/storage-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
storageType | Body | Enum | Data storage types |
storageSize | Body | Number | Block Storage Size (GB) |
storageStatus | Body | Enum | Data Storage Current Status - DETACHED : Detached- ATTACHED : Attached- DELETED : Deleted |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"storageType": "General SSD",
"storageSize": 20,
"storageStatus": "ATTACHED"
}
PUT /v1.0/db-instances/{dbInstanceId}/storage-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
storageSize | Body | Number | O | Block Storage Size (GB) - Minimum value: Current value - Maximum value: 2048 |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/network-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
availabilityZone | Body | Enum | Availability zone where DB instance will be created |
subnet | Body | Object | Subnet object |
subnet.subnetId | Body | UUID | Subnet identifier |
subnet.subnetName | Body | UUID | Name to identify subnets |
subnet.subnetCidr | Body | UUID | CIDR of subnet |
subnet.publicAccessible | Body | Boolean | External access is available or not |
endPoints | Body | Array | List of access information |
endPoints.domain | Body | String | Domain |
endPoints.ipAddress | Body | String | IP address |
endPoints.endPointType | Body | Enum | Types of access information - EXTERNAL : External access domain- INTERNAL : Internal access domain- PUBLIC : (Deprecated) External access domain- PRIVATE : (Deprecated) Internal access domain |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"availabilityZone": "kr-pub-a",
"subnet": {
"subnetId": "bd453789-34ae-416c-9f78-05b9e43a46be",
"subnetName": "Default Network",
"subnetCidr": "192.168.0.0/16",
"publicAccessible": true
},
"endPoints": [
{
"domain": "ea548a78-d85f-43b4-8ddf-c88d999b9905.internal.kr1.postgres.rds.nhncloudservice.com",
"ipAddress": "192.168.0.2",
"endPointType": "INTERNAL"
}
]
}
PUT /v1.0/db-instances/{dbInstanceId}/network-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
usePublicAccess | Body | Boolean | O | External access is available or not |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/backup-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
backupPeriod | Body | Number | Backup retention period |
backupRetryCount | Body | Number | Number of backup retries |
backupSchedules | Body | Array | Backup schedules |
backupSchedules.backupWndBgnTime | Body | String | Backup Start Time |
backupSchedules.backupWndDuration | Body | Enum | Backup Window Auto backup is executed within the set duration from the 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 |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"backupPeriod": 1,
"backupRetryCount": 0,
"backupSchedules": [
{
"backupWndBgnTime": "00:00:00",
"backupWndDuration": "ONE_HOUR_AND_HALF",
"backupRetryExpireTime": "01:30:00"
}
]
}
PUT /v1.0/db-instances/{dbInstanceId}/backup-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
backupPeriod | Body | Number | X | Backup retention period - Minimum value: 0 - Maximum value: 730 |
backupRetryCount | Body | Number | X | Number of backup retries - Minimum value: 0 - Maximum value: 10 |
backupSchedules | Body | Array | X | Backup schedules |
backupSchedules.backupWndBgnTime | Body | String | O | Backup Start Time - Example: 00:00:00 |
backupSchedules.backupWndDuration | Body | Enum | O | Backup Window Auto backup is executed within the set duration from the 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 |
{
"backupPeriod": 5,
"backupSchedules": [
{
"backupWndBgnTime": "01:00:00",
"backupWndDuration": "TWO_HOURS",
"backupRetryExpireTime": "03:00:00"
}
]
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/restoration-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
oldestRestorableYmdt | Body | DateTime | Oldest restoreable time |
latestRestorableYmdt | Body | DateTime | Most recent restoreable time |
restorableBackups | Body | Array | List of restoreable backups |
restorableBackups.backup | Body | Object | Backup information objects |
restorableBackups.backup.backupId | Body | UUID | Backup identifier |
restorableBackups.backup.backupName | Body | String | Backup name |
restorableBackups.backup.backupSize | Body | Number | Backup size |
restorableBackups.backup.backupType | Body | Enum | Backup type - AUTO : AutomaticMANUAL: Manual |
restorableBackups.backup.backupStatus | Body | Enum | Backup StatusBACKING_UP : Backup in progressCOMPLETED : Backup completedDELETING : Backup being deletedDELETED : Backup deletedERROR : Error occurred |
restorableBackups.backup.dbInstanceId | Body | UUID | Original DB instance identifier |
restorableBackups.backup.dbInstanceName | Body | String | Original DB instance name |
restorableBackups.backup.dbVersion | Body | String | DB version information |
restorableBackups.backup.failoverCount | Body | Number | Number of failovers |
restorableBackups.backup.walFileName | Body | String | WAL log file name |
restorableBackups.backup.createdYmdt | Body | DateTime | Date and time of backup creation |
restorableBackups.backup.updatedYmdt | Body | DateTime | Date and time of backup renewal |
restorableBackups.backup.startYmdt | Body | DateTime | When backups start |
restorableBackups.backup.completedYmdt | Body | DateTime | Backup completion date |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"oldestRestorableYmdt": "2023-07-09T16:33:33+09:00",
"latestRestorableYmdt": "2023-07-10T15:44:44+09:00",
"restorableBackups": [
{
"backup": {
"backupId": "145d889a-fe08-474f-8f58-bde576ff96a9",
"backupName": "example-backup-name",
"backupStatus": "COMPLETED",
"dbInstanceId": "dba1be25-9429-4589-9716-7fb6daad7cb9",
"dbInstanceName": "original-db-instance-name",
"dbVersion": "POSTGRESQL_V146",
"backupType": "MANUAL",
"backupSize": 8299904,
"walFileName": "000000010000000000000005",
"createdYmdt": "2023-07-10T15:44:44+09:00",
"updatedYmdt": "2023-07-10T15:46:07+09:00"
}
}
]
}
GET /v1.0/db-instances/{dbInstanceId}/restore
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Restore | Restore DB Instance |
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 typeTIMESTAMP : A point-in-time restoration type using the time within the restorable time- BACKUP : Restore type using a previously created backup |
dbInstanceName | Body | String | O | Name to identify DB instances |
description | Body | String | X | Additional information on DB instances |
dbFlavorId | Body | UUID | O | Identifier of DB instance specifications |
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 |
useDefaultNotification | Body | Boolean | X | Whether to use default notification Default: false |
useDeletionProtection | Body | Boolean | X | Whether to protect against deletion Default: false |
useHighAvailability | Body | Boolean | X | Whether to use high availability Default: false |
pingInterval | Body | Number | X | Ping interval (sec) when using high availability - Default: 3Minimum : 1- Maximum value: 600 |
failoverReplWaitingTime | Body | Number | X | Failover latency when using high availability - Minimum value: 0 - If set to -1, it will continue to wait for the replication delay to resolve. |
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 | X | Availability zone where DB instance will be created - Example: kr-pub-a - Default: Any availability zone |
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.backupRetryCount | Body | Number | X | Number of backup retries Default: 6 - Minimum value: 0 - Maximum value: 10 |
backup.backupSchedules | Body | Array | O | Backup schedules |
backup.backupSchedules.backupWndBgnTime | Body | String | X | Backup started time - Example: 00:00:00 - Default: Original DB instance value |
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- Default: Original DB instance value |
TIMESTAMP
)Name | Type | Format | Required | Description |
---|---|---|---|---|
restore.restoreYmdt | Body | DateTime | O | DB instance restore time. (YYYY-MM-DDThh:mm:ss.SSSTZD) Restoration is possible only before the most recent restorable time, which is queried through restoration information inquiry. |
{
"dbInstanceName": "db-instance",
"description": "description",
"dbFlavorId": "71f69bf9-3c01-4c1a-b135-bb75e93f6268",
"dbPort": 10000,
"dbUserName": "db-user",
"dbPassword": "password",
"parameterGroupId": "488bf4f5-d8f7-459b-ace6-529b606c8570",
"dbSecurityGroupIds": [
"b0483a3d-e8e2-46f6-9e84-d5e31b0d44f4"
],
"userGroupIds": [],
"network": {
"subnetId": "3ae7914f-9b42-4729-b125-87417b72cf36"
},
"storage": {
"storageType": "General SSD",
"storageSize": 20
},
"restore": {
"restoreType": "TIMESTAMP",
"restoreYmdt": "2023-07-10T15:44:44+09:00"
},
"backup": {
"backupPeriod": 1,
"backupSchedules": [
{
"backupWndBgnTime": "00:00:00",
"backupWndDuration": "ONE_HOUR_AND_HALF"
}
]
}
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
PUT /v1.0/db-instances/{dbInstanceId}/deletion-protection
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
useDeletionProtection | Body | Boolean | O | Whether to protect against deletion |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
GET /v1.0/db-instances/{dbInstanceId}/maintenance-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
allowAutoMaintenance | Body | Boolean | Whether to allow automatic maintenance |
useAutoStorageCleanup | Body | Boolean | Whether to enable automatic storage cleanup |
maintWndBgnTime | Body | String | Automatic maintenance start time - Example: 00:00:00 |
maintWndDuration | Body | ENUM | Maintenance window Examples: half_an_hour , one_hour , one_hour_and_half , two_hours , two_hours_and_half , three_hours |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"allowAutoMaintenance": true,
"useAutoStorageCleanup": true,
"maintWndBgnTime": "00:00:00",
"maintWndDuration": "HALF_AN_HOUR"
}
PUT /v1.0/db-instances/{dbInstanceId}/maintenance-info
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
allowAutoMaintenance | Body | Boolean | O | Whether to allow automatic maintenance |
useAutoStorageCleanup | Body | Boolean | O | Whether to enable automatic storage cleanup |
maintWndBgnTime | Body | String | O | Automatic maintenance start time - Example: 00:00:00 |
maintWndDuration | Body | ENUM | O | Maintenance window Examples: half_an_hour , one_hour , one_hour_and_half , two_hours , two_hours_and_half , three_hours |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
GET /v1.0/db-instances/{dbInstanceId}/available-db-versions
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Get | List DB Instance Details |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
dbVersions | Body | Array | DB version list |
dbVersions.dbVersion | Body | String | DB version |
dbVersions.dbVersionName | Body | String | DB version name |
dbVersions.restorableFromObs | Body | Boolean | Restoring backup from object storage available or not |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbVersions": [
{
"dbVersion": "POSTGRESQL_V146",
"dbVersionName": "PostgreSQL V14.6",
"restorableFromObs": true
}
]
}
DELETE /v1.0/db-instances/{dbInstanceId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Delete | Delete DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/restart
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Restart | Restart DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
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 |
{
"executeBackup": true
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/force-restart
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.ForceRestart | Force Restart DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
POST /v1.0/db-instances/{dbInstanceId}/start
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Start | Start DB Instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/stop
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Start | Start DB Instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/backup
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Backup | Backup DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
backupName | Body | String | O | Name to identify backups |
{
"backupName": "backup"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/backup-to-object-storage
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.BackupToObjectStorage | Export Backup Files to Object Storage After Backup |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
tenantId | Body | String | O | Tenant ID of object storage to store backup |
username | Body | String | O | ID of NHN Cloud Account or IAM Account |
password | Body | String | O | API password for object storage where backup is stored |
targetContainer | Body | String | O | Object storage container where backup is stored |
objectPath | Body | String | O | Backup path to be stored in container |
{
"tenantId": "399631c404744dbbb18ce4fa2dc71a5a",
"username": "gildong.hong@nhn.com",
"password": "password",
"targetContainer": "/container",
"objectPath": "/backups/backup_file"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/apply-recent-parameter-group
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
executeBackup | Body | Boolean | X | Whether to execute backup at this time Default: false |
{
"executeBackup": true
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/replicate
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Replicate | Replicate DB Instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
dbInstanceName | Body | String | O | Name to identify DB instances |
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: 0 - Maximum value: 65535 |
parameterGroupId | Body | UUID | X | Parameter group identifier - Default: Original DB instance value |
dbSecurityGroupIds | Body | Array | X | DB security group identifiers - Default: Original DB instance value |
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 |
network | Body | Object | X | Network information objects |
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 - Example: kr-pub-a - Default: Any availability zone |
storage | Body | Object | X | Storage information objects |
storage.storageType | Body | Enum | X | Data storage types - Example: General SSD |
storage.storageSize | Body | Number | X | Block Storage Size (GB) - Default: Original DB instance value - Minimum value: 20 - Maximum value: 2048 |
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 |
backup.backupRetryCount | Body | Number | X | Number of backup retries - Default: Original DB instance value - Minimum value: 0 - Maximum value: 10 |
{
"dbInstanceName": "db-instance-replicate",
"description": "description",
"dbPort": 15432,
"storage": {
"storageSize": 100
}
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/db-instances/{dbInstanceId}/promote
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Promote | Promote DB Instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/databases
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceDatabase.List | View a list of databases in a DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
databases | Body | Array | List of databases |
databases.databaseId | Body | UUID | Identifiers in the database |
databases.databaseName | Body | String | Database Name |
databases.databaseStatus | Body | Enum | Current state of the database - STABLE : Created(CREATING: Creating, - MODIFYING : Modifying- SYNCING : SynchronizingDELETING: Deleting, - DELETED : Deleted |
databases.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
databases.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
databases.schemas | Body | Array | List of schemas in the database |
databases.schemas.schemaName | Body | String | Schema name |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"databases": [
{
"databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
"databaseName": "database",
"databaseStatus": "STABLE",
"createdYmdt": "2023-03-20T13:37:45+09:00",
"updatedYmdt": "2023-03-20T13:37:45+09:00",
"schemas": [
{
"schemaName": "rds"
}
]
}
]
}
POST /v1.0/db-instances/{dbInstanceId}/databases
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceDatabase.Create | Creating a database within a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
databaseName | Body | String | O | Database Name |
{
"databaseName": "database"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
PUT /v1.0/db-instances/{dbInstanceId}/databases/{databaseId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceDatabase.Modify | Modifying databases within a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
databaseId | URL | UUID | O | Identifiers in the database |
databaseName | Body | String | O | Database Name |
applyHbaRulesImmediately | Body | Boolean | X | Whether to apply associated access control rules immediately - When you change the database name, any access control rules set under the old database name are reflected with the changed name. |
{
"databaseName": "database-1"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
DELETE /v1.0/db-instances/{dbInstanceId}/databases/{databaseId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceDatabase.Delete | Deleting a database within a DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
databaseId | URL | UUID | O | Identifiers in the database |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/db-users
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceUser.List | Viewing a list of users in a DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
dbUsers | Body | Array | DB users |
dbUsers.dbUserId | Body | UUID | DB user identifier |
dbUsers.dbUserName | Body | String | DB user account name |
dbUsers.authorityType | Body | Enum | DB user permission types - CRUD : Permission to execute DML query- DDL : Permission to execute DDL query |
dbUsers.dbUserStatus | Body | Enum | DB user current status - STABLE : Created(CREATING: Creating, - MODIFYING : Modifying- SYNCING : SynchronizingDELETING: Deleting, - DELETED : Deleted |
dbUsers.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
dbUsers.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"databases": [
{
"databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
"databaseName": "database",
"databaseStatus": "STABLE",
"createdYmdt": "2023-03-20T13:37:45+09:00"
}
]
}
POST /v1.0/db-instances/{dbInstanceId}/db-users
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceUser.Create | Creating a user in a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
dbUserName | Body | String | O | DB user account name - Minimum length: 1 - Maximum length: 32 |
dbPassword | Body | String | O | DB user account password - Minimum length: 1 - Maximum length: 32 |
authorityType | Body | Enum | O | DB user permission types - CRUD : Permission to execute DML query- DDL : Permission to execute DDL query |
createDefaultHbaRules | Body | Boolean | X | Whether to create default access control rules |
address | Body | String | X | Connection address to use when creating default access control rules |
{
"dbUserName": "db-user",
"dbPassword": "password",
"authorityType": "CRUD"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
PUT /v1.0/db-instances/{dbInstanceId}/db-users/{dbUserId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceUser.Modify | Modifying users in a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
dbUserId | URL | UUID | O | DB user identifier |
dbUserName | Body | String | X | DB user account name - Minimum length: 1 - Maximum length: 32 |
dbPassword | Body | String | X | DB user account password - Minimum length: 1 - Maximum length: 32 |
authorityType | Body | Enum | X | DB user permission types - CRUD : Permission to execute DML query- DDL : Permission to execute DDL query |
applyHbaRulesImmediately | Body | Boolean | X | Whether to apply associated access control rules immediately - When you change a user account name, any access control rules set under the old user account name are reflected with the changed name. |
{
"dbUserName": "db-user-1",
"dbPassword": "new-password"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
DELETE /v1.0/db-instances/{dbInstanceId}/db-users/{dbUserId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceUser.Delete | Deleting a user in a DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
dbUserId | URL | UUID | O | DB user identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-instances/{dbInstanceId}/hba-rules
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceHba.List | View a list of access control rules in a DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
hbaRules | Body | Array | List of access control rules |
hbaRules.hbaRuleId | Body | UUID | Identifiers for access control rules |
hbaRules.hbaRuleStatus | Body | Enum | Current status of access control rules - CREATED: Created - APPLIED : Applied(CREATING: Creating, - MODIFYING : ModifyingDELETING: Deleting, - DELETED : Deleted |
hbaRules.databaseApplyType | Body | String | How database rules are applied - ENTIRE : All- USER_CUSTOM : Customize |
hbaRules.dbUserApplyType | Body | Enum | How DB user rules are applied - ENTIRE : All- USER_CUSTOM : Customize |
hbaRules.databases | Body | Array | List of custom databases |
hbaRules.databases.databaseId | Body | UUID | Identifiers for custom databases |
hbaRules.databases.databaseName | Body | String | Custom database name |
hbaRules.dbUsers | Body | Array | Custom DB user list |
hbaRules.dbUsers.dbUserId | Body | UUID | Identifier of the custom DB user |
hbaRules.dbUsers.dbUserName | Body | String | Custom DB user account name |
hbaRules.address | Body | String | Access Address |
hbaRules.authMethod | Body | Enum | Authentication Method - TRUST : Trust (no password required)- REJECT : Block access- SCRAM_SHA_256 : Password (SCRAM-SHA-256) |
hbaRules.reservedAction | Body | Enum | Preliminaries - NONE : None- CREATE : Schedule a creation (requires application)- MODIFY : Schedule a modification (requires application)- DELETE : Schedule a delete (requires enforcement) |
hbaRules.order | Body | Number | Application order |
hbaRules.applicable | Body | Boolean | Applicability - Rules with an inapplicable status are ignored |
needToApply | Body | Boolean | Whether changes need to be made |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"hbaRules": [
{
"hbaRuleId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
"hbaRuleStatus": "APPLIED",
"databaseApplyType": "USER_CUSTOM",
"dbUserApplyType": "ENTIRE",
"databases": [
{
"databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
"databaseName": "database"
}
],
"dbUsers": [],
"address": "0.0.0.0/0",
"authMethod": "TRUST",
"reservedAction": "NONE",
"order": 0,
"applicable": true
}
]
}
POST /v1.0/db-instances/{dbInstanceId}/hba-rules
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceHba.Create | Adding access control rules within a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
databaseApplyType | Body | String | O | How database rules are applied - ENTIRE : All- USER_CUSTOM : Customize |
dbUserApplyType | Body | Enum | O | How DB user rules are applied - ENTIRE : All- USER_CUSTOM : Customize |
databaseIds | Body | Array | X | List of identifiers for a custom database |
dbUserIds | Body | Array | X | List of identifiers for custom DB users |
address | Body | String | O | Access Address - Enter in CIDR format, hostname, or domain format |
authMethod | Body | Enum | O | Authentication Method - TRUST : Trust (no password required)- REJECT : Block access- SCRAM_SHA_256 : Password (SCRAM-SHA-256) |
{
"databaseApplyType": "ENTIRE",
"dbUserApplyType": "USER_CUSTOM",
"databaseIds": [],
"dbUserIds": [
"7c9a94b8-86c1-435d-8af2-82a5e9d53fd4"
],
"address": "0.0.0.0/0",
"authMethod": "TRUST"
}
Name | Type | Format | Description |
---|---|---|---|
hbaRuleId | Body | UUID | Identifiers for access control rules |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"hbaRuleId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
PUT /v1.0/db-instances/{dbInstanceId}/hba-rules/{hbaRuleId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceHba.Modify | Modifying access control rules within a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
hbaRuleId | URL | UUID | O | Identifiers for access control rules |
databaseApplyType | Body | String | O | How database rules are applied - ENTIRE : All- USER_CUSTOM : Customize |
dbUserApplyType | Body | Enum | O | How DB user rules are applied - ENTIRE : All- USER_CUSTOM : Customize |
databaseIds | Body | Array | X | List of identifiers for a custom database |
dbUserIds | Body | Array | X | List of identifiers for custom DB users |
address | Body | String | O | Access Address - Enter in CIDR format, hostname, or domain format |
authMethod | Body | Enum | O | Authentication Method - TRUST : Trust (no password required)- REJECT : Block access- SCRAM_SHA_256 : Password (SCRAM-SHA-256) |
{
"databaseApplyType": "ENTIRE",
"dbUserApplyType": "ENTIRE",
"databaseIds": [],
"dbUserIds": [],
"address": "0.0.0.0/0",
"authMethod": "REJECT"
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
DELETE /v1.0/db-instances/{dbInstanceId}/hba-rules/{hbaRuleId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceHba.Delete | Deleting an access control rule in a DB instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
hbaRuleId | URL | UUID | O | Identifiers for access control rules |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
PUT /v1.0/db-instances/{dbInstanceId}/hba-rules/orders
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstanceHba.Modify | Modifying access control rules within a DB instance |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
hbaRuleIds | URL | Body | O | List of identifiers for access control rules - Adjusted in the order you requested |
{
"hbaRuleIds": [
"7c9a94b8-86c1-435d-8af2-82a5e9d53fd4"
]
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
POST /v1.0/db-instances/{dbInstanceId}/hba-rules/apply
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbInstance.Modify | Modify DB Instance |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | URL | UUID | O | DB instance identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/backups
Permission Name | Description |
---|---|
RDSforPostgreSQL:Backup.List | Retrieve Backup List |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
page | Query | Number | O | Page to retrieve - Minimum value: 1 |
size | Query | Number | O | Page size to retrieve - Minimum value: 1 - Maximum value: 100 |
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 version information |
Name | Type | Format | Description |
---|---|---|---|
totalCounts | Body | Number | Number of all backup lists |
backups | Body | Array | Backup list |
backups.backupId | Body | UUID | Backup identifier |
backups.backupName | Body | String | Name to identify backups |
backups.backupStatus | Body | Enum | Backup current statusBACKING_UP : Backup in progressCOMPLETED : Backup completedDELETING : Backup being deletedDELETED : Backup deletedERROR : Error occurred |
backups.dbInstanceId | Body | UUID | Original DB instance identifier |
backups.dbVersion | Body | Enum | DB version information |
backups.backupType | Body | Enum | Backup type - AUTO : Automatic- MANUAL : Manual |
backups.backupSize | Body | Number | Size of the backup - Unit: Bytes |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
completedYmdt | Body | DateTime | End date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"totalCounts": 1,
"backups": [
{
"backupId": "0017f136-3e01-4530-94aa-20661afe6632",
"backupName": "backup",
"backupStatus": "COMPLETED",
"dbInstanceId": "142e6ccc-3bfb-4e1e-84f7-38861284fafd",
"dbVersion": "POSTGRESQL_V146",
"backupType": "AUTO",
"backupSize": 4996786,
"createdYmdt": "2023-02-21T00:35:00+09:00",
"updatedYmdt": "2023-02-22T00:35:32+09:00",
"completedYmdt": "2023-02-22T00:35:32+09:00"
}
]
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/backups/{backupId}/export
Permission Name | Description |
---|---|
RDSforPostgreSQL:Backup.Export | Export backup to object storage |
Name | Type | Format | Required | Description |
---|---|---|---|---|
backupId | URL | UUID | O | Backup identifier |
tenantId | Body | String | O | Tenant ID of object storage to store backup |
username | Body | String | O | ID of NHN Cloud Account or IAM Account |
password | Body | String | O | API password for object storage where backup is stored |
targetContainer | Body | String | O | Object storage container where backup is stored |
objectPath | Body | String | O | Backup path to be stored in container |
{
"tenantId": "399631c404744dbbb18ce4fa2dc71a5a",
"username": "gildong.hong@nhn.com",
"password": "password",
"targetContainer": "/container",
"objectPath": "/backups/backup_file"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
POST /v1.0/backups/{backupId}/restore
Permission Name | Description |
---|---|
RDSforPostgreSQL:Backup.Restore | Restore Backup |
Name | Type | Format | Required | Description |
---|---|---|---|---|
backupId | URL | UUID | O | Backup identifier |
dbInstanceName | Body | String | O | Name to identify DB instances |
description | Body | String | X | Additional information on DB instances |
dbFlavorId | Body | UUID | O | Identifier of DB instance specifications |
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 |
useDefaultNotification | Body | Boolean | X | Whether to use default notification Default: false |
useDeletionProtection | Body | Boolean | X | Whether to protect against deletion Default: false |
useHighAvailability | Body | Boolean | X | Whether to use high availability |
pingInterval | Body | Number | X | Ping interval (sec) when using high availability - Minimum value: 1 - Maximum value: 600 |
failoverReplWaitingTime | Body | Number | X | Failover latency when using high availability - Minimum value: 0 - If set to -1, it will continue to wait for the replication delay to resolve. |
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 | X | Availability zone where DB instance will be created - Example: kr-pub-a - Default: Any availability zone |
storage | Body | Object | O | Storage information objects |
storage.storageType | Body | Enum | O | Data storage types - Example: General SSD |
storage.storageSize | Body | Number | O | Data storage size - Unit: Gigabytes - 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.backupRetryCount | Body | Number | X | Number of backup retries Default: 6 - Minimum value: 0 - Maximum value: 10 |
backup.backupSchedules | Body | Array | X | Backup schedules |
backup.backupSchedules.backupWndBgnTime | Body | String | O | Backup Start Time - Example: 00:00:00 |
backup.backupSchedules.backupWndDuration | Body | Enum | O | Backup duration Auto backup is executed within the set duration from the 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 |
{
"dbInstanceName": "db-instance-restore",
"dbFlavorId": "50be6d9c-02d6-4594-a2d4-12010eb65ec0",
"dbPort": 15432,
"parameterGroupId": "132d383c-38e3-468a-a826-5e9a8fff15d0",
"network": {
"subnetId": "e721a9dd-dad0-4cf0-a53b-dd654ebfc683"
},
"storage": {
"storageType": "General SSD",
"storageSize": 20
},
"backup": {
"backupPeriod": 1,
"backupSchedules": [
{
"backupWndBgnTime": "00:00:00",
"backupWndDuration": "HALF_AN_HOUR",
"backupRetryExpireTime": "00:30:00"
}
]
}
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
DELETE /v1.0/backups/{backupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:Backup.Delete | Delete Backup |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
backupId | URL | UUID | O | Backup identifier |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/db-security-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroup.List | List DB Security Groups |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
dbSecurityGroups | Body | Array | DB security groups |
dbSecurityGroups.dbSecurityGroupId | Body | UUID | DB security group identifier |
dbSecurityGroups.dbSecurityGroupName | Body | String | Name to identify DB instances |
dbSecurityGroups.dbSecurityGroupStatus | Body | Enum | Current status of DB security groups - CREATED: Created - DELETED : Deleted |
dbSecurityGroups.description | Body | String | Additional information on DB security group |
dbSecurityGroups.progressStatus | Body | Enum | Current status of DB security group - NONE : No work in progress- CREATING_RULE : Creating rule policy- UPDATING_RULE : Modifying rule policy- DELETING_RULE : Deleting rule policy- APPLYING_DEFAULT_RULE : Applying default rule |
dbSecurityGroups.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
dbSecurityGroups.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbSecurityGroups": [
{
"dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708",
"dbSecurityGroupName": "dbSecurityGroup",
"dbSecurityGroupStatus": "CREATED",
"description": "description",
"progressStatus": "NONE",
"createdYmdt": "2023-02-19T19:18:13+09:00",
"updatedYmdt": "2022-02-19T19:18:13+09:00"
}
]
}
GET /v1.0/db-security-groups/{dbSecurityGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroup.Get | List DB Security Group Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupId | URL | UUID | O | DB security group identifier |
Name | Type | Format | Description |
---|---|---|---|
dbSecurityGroupId | Body | UUID | DB security group identifier |
dbSecurityGroupName | Body | String | Name to identify DB instances |
dbSecurityGroupStatus | Body | Enum | Current status of DB security groups - CREATED: Created - DELETED : Deleted |
description | Body | String | Additional information on DB security group |
progressStatus | Body | Enum | Current status of DB security group - NONE : No work in progress- CREATING_RULE : Creating rule policy- UPDATING_RULE : Modifying rule policy- DELETING_RULE : Deleting rule policy- APPLYING_DEFAULT_RULE : Applying default rule |
rules | Body | Array | DB security group rules |
rules.ruleId | Body | UUID | DB security group rule identifier |
rules.description | Body | String | Additional information on DB security group rule |
rules.direction | Body | Enum | Communication direction - INGRESS : Inbound- EGRESS : Outbound |
rules.etherType | Body | Enum | Ether type - IPV4 : IPv4- IPV6 : IPv6 |
rules.port | Body | Object | Port object |
rules.port.portType | Body | Enum | Port type - DB_PORT : Sets to DB instance port value.- PORT : Sets to specified port value.- PORT_RANGE : Sets to specified port range. |
rules.port.minPort | Body | Number | Minimum port range |
rules.port.maxPort | Body | Number | Maximum port range |
rules.cidr | Body | String | Remote source for traffic to allow |
rules.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
rules.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbSecurityGroup": {
"dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708",
"dbSecurityGroupName": "dbSecurityGroup",
"dbSecurityGroupStatus": "CREATED",
"description": "description",
"progressStatus": "NONE",
"rules": [
{
"ruleId": "17c88ef6-95f1-4678-84f9-fee1b22e250d",
"description": "description",
"direction": "INGRESS",
"etherType": "IPV4",
"port": {
"portType": "PORT_RANGE",
"minPort": 10000,
"maxPort": 10005
},
"cidr": "0.0.0.0/0",
"createdYmdt": "2023-02-19T19:18:13+09:00",
"updatedYmdt": "2023-02-19T19:18:13+09:00"
}
],
"createdYmdt": "2023-02-19T19:18:13+09:00",
"updatedYmdt": "2023-02-19T19:18:13+09:00"
}
}
POST /v1.0/db-security-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroup.Create | Create DB Security Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupName | Body | String | O | Name to identify DB instances |
description | Body | String | X | Additional information on DB security group |
rules | Body | Array | O | DB security group rules |
rules.description | Body | String | X | Additional information on DB security group rule |
rules.direction | Body | Enum | O | Communication direction - INGRESS : Inbound- EGRESS : Outbound |
rules.etherType | Body | Enum | O | Ether type - IPV4 : IPv4- IPV6 : IPv6 |
rules.cidr | Body | String | O | Remote source for traffic to allow - Example: 1.1.1.1/32 |
rules.port | Body | Object | O | Port object |
rules.port.portType | Body | Enum | O | Port type - DB_PORT : Sets to DB instance port value. Values for minPort 값과 maxPort are not required.- PORT : 지정된 포트값으로 설정됩니다. minPort 값과 maxPort 값이 같아야 합니다.- PORT_RANGE : Sets to specified port range. |
rules.port.minPort | Body | Number | X | Minimum port range - Minimum value received: 5432 - Transmit minimum: 1 |
rules.port.maxPort | Body | Number | X | Maximum port range - Maximum received: 45432 - Send maximum: 65535 |
{
"dbSecurityGroupName": "dbSecurityGroup",
"description": "description",
"rules": [
{
"direction": "INGRESS",
"etherType": "IPV4",
"port": {
"portType": "PORT_RANGE",
"minPort": 10000,
"maxPort": 10005
},
"cidr": "0.0.0.0/0"
}
]
}
Name | Type | Format | Description |
---|---|---|---|
dbSecurityGroupId | Body | UUID | DB security group identifier |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708"
}
PUT /v1.0/db-security-groups/{dbSecurityGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroup.Modify | Modify DB Security Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupId | URL | UUID | O | DB security group identifier |
dbSecurityGroupName | Body | String | X | Name to identify DB instances |
description | Body | String | X | Additional information on DB security group |
{
"dbSecurityGroupName": "dbSecurityGroup",
"description": "description"
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
DELETE /v1.0/db-security-groups/{dbSecurityGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroup.Delete | Delete DB Security Group |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupId | URL | UUID | O | DB security group identifier |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
POST /v1.0/db-security-groups/{dbSecurityGroupId}/rules
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroupRule.Create | Create DB Security Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupId | URL | UUID | O | DB security group identifier |
description | Body | String | X | Additional information on DB security group rule |
direction | Body | Enum | O | Communication direction - INGRESS : Inbound- EGRESS : Outbound |
etherType | Body | Enum | O | Ether type - IPV4 : IPv4- IPV6 : IPv6 |
port | Body | Object | O | Port object |
port.portType | Body | Enum | O | Port type - DB_PORT : Sets to DB instance port value. Values for minPort 값과 maxPort are not required.- PORT : 지정된 포트값으로 설정됩니다. minPort 값과 maxPort 값이 같아야 합니다.- PORT_RANGE : Sets to specified port range. |
port.minPort | Body | Number | X | Minimum port range - Minimum value received: 5432 - Transmit minimum: 1 |
port.maxPort | Body | Number | X | Maximum port range - Maximum received: 45432 - Send maximum: 65535 |
cidr | Body | String | O | Remote source for traffic to allow - Example: 1.1.1.1/32 |
{
"direction": "INGRESS",
"etherType": "IPV4",
"port": {
"portType": "PORT",
"minPort": 10000,
"maxPort": 10000
},
"cidr": "0.0.0.0/0"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
PUT /v1.0/db-security-groups/{dbSecurityGroupId}/rules/{ruleId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroupRule.Modify | Modify DB Security Group Rule |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupId | URL | UUID | O | DB security group identifier |
ruleId | URL | UUID | O | DB security group rule identifier |
description | Body | String | X | Additional information on DB security group rule |
direction | Body | Enum | O | Communication direction - INGRESS : Inbound- EGRESS : Outbound |
etherType | Body | Enum | O | Ether type - IPV4 : IPv4- IPV6 : IPv6 |
port | Body | Object | O | Port object |
port.portType | Body | Enum | O | Port type - DB_PORT : Sets to DB instance port value. Values for minPort 값과 maxPort are not required.- PORT : 지정된 포트값으로 설정됩니다. minPort 값과 maxPort 값이 같아야 합니다.- PORT_RANGE : Sets to specified port range. |
port.minPort | Body | Number | X | Minimum port range - Minimum value received: 5432 - Transmit minimum: 1 |
port.maxPort | Body | Number | X | Maximum port range - Maximum received: 45432 - Send maximum: 65535 |
cidr | Body | String | O | Remote source for traffic to allow - Example: 1.1.1.1/32 |
{
"direction": "INGRESS",
"etherType": "IPV4",
"port": {
"portType": "DB_PORT"
},
"cidr": "0.0.0.0/0"
}
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
DELETE /v1.0/db-security-groups/{dbSecurityGroupId}/rules
Permission Name | Description |
---|---|
RDSforPostgreSQL:DbSecurityGroupRule.Create | Delete DB Security Group Rule |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbSecurityGroupId | URL | UUID | O | DB security group identifier |
ruleIds | Query | Array | O | DB security group rule identifiers |
Name | Type | Format | Description |
---|---|---|---|
jobId | Body | UUID | Identifier of requested task |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}
GET /v1.0/parameter-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.List | List Parameter Groups |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbVersion | Query | Enum | X | DB version information |
Name | Type | Format | Description |
---|---|---|---|
parameterGroups | Body | Array | Parameter groups |
parameterGroups.parameterGroupId | Body | UUID | Parameter group identifier |
parameterGroups.parameterGroupName | Body | String | Name to identify parameter groups |
parameterGroups.parameterGroupStatus | Body | Enum | Parameter group current status - STABLE : Applied- NEED_TO_APPLY : Need to apply |
parameterGroups.description | Body | String | Additional information on parameter group |
parameterGroups.dbVersion | Body | Enum | DB version information |
parameterGroups.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
parameterGroups.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"parameterGroups": [
{
"parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7",
"parameterGroupName": "parameter-group",
"parameterGroupStatus": "STABLE",
"description": null,
"dbVersion": "POSTGRESQL_V146",
"createdYmdt": "2023-02-31T15:28:17+09:00",
"updatedYmdt": "2023-02-31T15:28:17+09:00"
}
]
}
GET /v1.0/parameter-groups/{parameterGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Get | List Parameter Group Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupId | URL | UUID | O | Parameter group identifier |
Name | Type | Format | Description |
---|---|---|---|
parameterGroupId | Body | UUID | Parameter group identifier |
parameterGroupName | Body | String | Name to identify parameter groups |
description | Body | String | Additional information on parameter group |
dbVersion | Body | Enum | DB version information |
parameterGroupStatus | Body | Enum | Parameter group current status - STABLE : Applied- NEED_TO_APPLY : Need to apply- DELETED : Deleted |
parameters | Body | Array | Parameter list |
parameters.parameterCategory | Body | String | Parameter Categories |
parameters.parameterName | Body | String | Parameter name |
parameters.value | Body | String | Current value |
parameters.valueUnit | Body | Enum | The units of the currently set value - B : Bytes- kB : Kilobyte- MB : Megabytes- GB : Gigabyte- TB : Terabyte- us : Microseconds- ms : milliseconds- s : seconds- min : Minutes- h : hour- d : day |
parameters.defaultValue | Body | String | Default value |
parameters.allowedValue | Body | String | Permitted values |
parameters.valueType | Body | Enum | Value type - BOOLEAN: Boolean type- STRING : String type- NUMERIC : Integer and floating-point types- NUMERIC_WITH_BYTE_UNIT : Numeric type with byte unit (e.g. 120 KB, 100 MB)- NUMERIC_WITH_TIME_UNIT : Numeric type with time unit (e.g. 120ms, 100s, 1d)- ENUMERATED : Enter one of the values declared in Allowed Values- MULTI_ENUMERATED : Enter multiple of the values declared in Allowed values (separated by commas (,))- TIMEZONE : Timezone type |
parameters.updateType | Body | Enum | Modification type - VARIABLE : Modifiable any time- CONSTANT : Not modifiable |
parameters.applyType | Body | Enum | Applied type - SESSION : Apply session- FILE : Apply setting file (restart required)- BOTH : All |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
expressionAvailable | Body | Boolean | Allow formulas or not |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7",
"parameterGroupName": "parameter-group",
"description": null,
"dbVersion": "POSTGRESQL_V146",
"parameterGroupStatus": "STABLE",
"parameters": [
{
"parameterCategory": "Write-Ahead Log / Checkpoints",
"parameterName": "checkpoint_timeout",
"value": "300s",
"defaultValue": "300s",
"allowedValue": "30~86400s",
"valueType": "NUMERIC_WITH_TIME_UNIT",
"updateType": "VARIABLE",
"applyType": "BOTH",
"expressionAvailable": true
}
],
"createdYmdt": "2023-03-13T11:02:28+09:00",
"updatedYmdt": "2023-03-13T11:02:28+09:00"
}
POST /v1.0/parameter-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Create | Create Parameter Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupName | Body | String | O | Name to identify parameter groups |
description | Body | String | X | Additional information on parameter group |
dbVersion | Body | Enum | O | DB version information |
{
"parameterGroupName": "parameter-group",
"description": "description",
"dbVersion": "POSTGRESQL_V146"
}
Name | Type | Format | Description |
---|---|---|---|
parameterGroupId | Body | UUID | Parameter group identifier |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7"
}
POST /v1.0/parameter-groups/{parameterGroupId}/copy
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Copy | Copy Parameter Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupId | URL | UUID | O | Parameter group identifier |
parameterGroupName | Body | String | O | Name to identify parameter groups |
description | Body | String | X | Additional information on parameter group |
{
"parameterGroupName": "parameter-group-copy",
"description": "copy"
}
Name | Type | Format | Description |
---|---|---|---|
parameterGroupId | Body | UUID | Parameter group identifier |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7"
}
PUT /v1.0/parameter-groups/{parameterGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Modify | Modify Parameter Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupId | URL | UUID | O | Parameter group identifier |
parameterGroupName | Body | String | X | Name to identify parameter groups |
description | Body | String | X | Additional information on parameter group |
{
"parameterGroupName": "parameter-group",
"description": "description"
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
PUT /v1.0/parameter-groups/{parameterGroupId}/parameters
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Modify | Modify Parameter Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupId | URL | UUID | O | Parameter group identifier |
modifiedParameters | Body | Array | O | Parameters to change |
modifiedParameters.parameterName | Body | UUID | O | Parameter name |
modifiedParameters.value | Body | String | O | Parameter value to change |
{
"modifiedParameters": [
{
"parameterName": "checkpoint_timeout",
"value": "100s"
}
]
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
PUT /v1.0/parameter-groups/{parameterGroupId}/reset
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Reset | Reset Parameter Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupId | URL | UUID | O | Parameter group identifier |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
DELETE /v1.0/parameter-groups/{parameterGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:ParameterGroup.Delete | Delete Parameter Group |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
parameterGroupId | URL | UUID | O | Parameter group identifier |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
GET /v1.0/user-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:UserGroup.List | List User Groups |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
userGroups | Body | Array | User Groups |
userGroups.userGroupId | Body | UUID | User group identifier |
userGroups.userGroupName | Body | String | Name to identify user groups |
userGroupStatus | Body | Enum | Current status of user groups - CREATED: Created - DELETED : Deleted |
userGroups.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
userGroups.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"userGroups": [
{
"userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0",
"userGroupName": "dev-team",
"userGroupStatus": "CREATED",
"createdYmdt": "2023-02-23T10:07:54+09:00",
"updatedYmdt": "2023-02-26T01:15:50+09:00"
}
]
}
GET /v1.0/user-groups/{userGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:UserGroup.Get | List User Group Details |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
userGroupId | URL | UUID | O | User group identifier |
Name | Type | Format | Description |
---|---|---|---|
userGroupId | Body | UUID | User group identifier |
userGroupName | Body | String | Name to identify user groups |
userGroupTypeCode | Body | Enum | User group type ENTIRE : User group including all project members INDIVIDUAL_MEMBER : User group including specific project members |
userGroupStatus | Body | Enum | Current status of user groups - CREATED: Created - DELETED : Deleted |
members | Body | Array | Project member list |
members.memberId | Body | UUID | Project member identifier |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0",
"userGroupName": "dev-team",
"userGroupStatus": "CREATED",
"userGroupTypeCode": "INDIVIDUAL_MEMBER",
"members": [
{
"memberId": "1321e759-2ef3-4b85-9921-b13e918b24b5"
}
],
"createdYmdt": "2023-02-23T10:07:54+09:00",
"updatedYmdt": "2023-02-26T01:15:50+09:00"
}
POST /v1.0/user-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:UserGroup.Create | Create User Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
userGroupName | Body | String | O | Name to identify user groups |
memberIds | Body | Array | O | Project member identifiers Ignored when selectAllYN is true |
selectAllYN | Body | Boolean | X | All project members or not If true, the group is set for all members |
{
"userGroupName": "dev-team",
"memberIds": ["1321e759-2ef3-4b85-9921-b13e918b24b5"]
}
{
"userGroupName": "dev-team",
"selectAllYN":true
}
Name | Type | Format | Description |
---|---|---|---|
userGroupId | Body | UUID | User group identifier |
PUT /v1.0/user-groups/{userGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:UserGroup.Modify | Modify User Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
userGroupId | URL | UUID | O | User group identifier |
userGroupName | Body | String | X | Name to identify user groups |
memberIds | Body | Array | X | Project member identifiers |
selectAllYN | Body | Boolean | X | All project members or not If true, the group is set for all members |
{
"userGroupName": "dev-team",
"memberIds": ["1321e759-2ef3-4b85-9921-b13e918b24b5","f9064b09-2b15-442e-a4b0-3a5a2754555e"]
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
DELETE /v1.0/user-groups/{userGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:UserGroup.Delete | Delete User Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
userGroupId | URL | UUID | O | User group identifier |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
GET /v1.0/notification-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationGroup.List | List Notification Groups |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
notificationGroups | Body | Array | Notification Groups |
notificationGroups.notificationGroupId | Body | UUID | Notification group identifier |
notificationGroups.notificationGroupName | Body | String | Name to identify notification groups |
notificationGroups.notificationGroupStatus | Body | Enum | Current status of notification groups - CREATED: Created - DELETED : Deleted |
notificationGroups.notifyEmail | Body | Boolean | Whether to be notified by email |
notificationGroups.notifySms | Body | Boolean | Whether to be notified by SMS |
notificationGroups.isEnabled | Body | Boolean | Indicates whether the flavor is enabled |
notificationGroups.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
notificationGroups.updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"notificationGroups": [
{
"notificationGroupId": "b3901f17-9971-4d1e-8a81-8448cf533dc7",
"notificationGroupName": "dev-team-noti",
"notifyEmail": true,
"notifySms": false,
"isEnabled": true,
"createdYmdt": "2023-02-20T13:34:13+09:00",
"updatedYmdt": "2023-02-20T13:34:13+09:00"
}
]
}
GET /v1.0/notification-groups/{notificationGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationGroup.Get | List Notification Groups |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupId | URL | UUID | O | Notification group identifier |
Name | Type | Format | Description |
---|---|---|---|
notificationGroupId | Body | UUID | Notification group identifier |
notificationGroupName | Body | String | Name to identify notification groups |
notificationGroupStatus | Body | Enum | Current status of notification groups - CREATED: Created - DELETED : Deleted |
notifyEmail | Body | Boolean | Whether to be notified by email |
notifySms | Body | Boolean | Whether to be notified by SMS |
isEnabled | Body | Boolean | Indicates whether the flavor is enabled |
dbInstances | Body | Array | DB Instances to monitor |
dbInstances.dbInstanceId | Body | UUID | DB instance identifier |
dbInstances.dbInstanceName | Body | String | Name to identify DB instances |
userGroups | Body | Array | User Groups |
userGroups.userGroupId | Body | UUID | User group identifier |
userGroups.userGroupName | Body | String | Name to identify user groups |
createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
updatedYmdt | Body | DateTime | Modified date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"notificationGroupId": "b3901f17-9971-4d1e-8a81-8448cf533dc7",
"notificationGroupName": "dev-team-noti",
"notifyEmail": true,
"notifySms": false,
"isEnabled": true,
"dbInstances": [
{
"dbInstanceId": "ed5cb985-526f-4c54-9ae0-40288593de65",
"dbInstanceName": "database"
}
],
"userGroups": [
{
"userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0",
"userGroupName": "dev-team"
}
],
"createdYmdt": "2023-02-20T13:34:13+09:00",
"updatedYmdt": "2023-02-20T13:34:13+09:00"
}
POST /v1.0/notification-groups
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationGroup.Create | Create Notification Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupName | Body | String | O | Name to identify notification groups |
notifyEmail | Body | Boolean | X | Whether to be notified by email Default: true |
notifySms | Body | Boolean | X | Whether to be notified by SMS Default: true |
isEnabled | Body | Boolean | X | Indicates whether the flavor is enabled Default: true |
dbInstanceIds | Body | Array | X | DB instance identifiers to monitor |
userGroupIds | Body | Array | X | User group identifiers |
{
"notificationGroupName": "dev-team-noti",
"notifyEmail": false,
"isEnable": true,
"dbInstanceIds": ["ed5cb985-526f-4c54-9ae0-40288593de65"],
"userGroupIds": ["1aac0437-f32d-4923-ad3c-ac61c1cfdfe0"]
}
Name | Type | Format | Description |
---|---|---|---|
notificationGroupId | Body | UUID | Notification group identifier |
PUT /v1.0/notification-groups/{notificationGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationGroup.Modify | Modify Notification Group |
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupId | URL | UUID | O | Notification group identifier |
notificationGroupName | Body | String | X | Name to identify notification groups |
notifyEmail | Body | Boolean | X | Whether to be notified by email |
notifySms | Body | Boolean | X | Whether to be notified by SMS |
isEnabled | Body | Boolean | X | Indicates whether the flavor is enabled |
dbInstanceIds | Body | Array | X | DB instance identifiers to monitor |
userGroupIds | Body | Array | X | User group identifiers |
{
"notifyEmail": true,
"dbInstanceIds": ["ed5cb985-526f-4c54-9ae0-40288593de65", "d51b7da0-682f-47ff-b588-b739f6adc740"]
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
DELETE /v1.0/notification-groups/{notificationGroupId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationGroup.Delete | Delete Notification Group |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupId | URL | UUID | O | Notification group identifier |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
GET /v1.0/notification-groups/{notificationGroupId}/watchdogs
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationWatchdog.List | View the list of watch settings |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
notificationGroupId | URL | UUID | Notification group identifier |
watchdogs | Body | Array | List of watch settings |
watchdogs.watchdogId | Body | UUID | Identifier of the watch setting |
watchdogs.metricName | Body | Enum | Performance metrics to watch - For the performance metrics you can set, see Viewing the performance metrics list. |
watchdogs.comparisonOperator | Body | Enum | How to compare watchlists - LE : <=- LT : <- GE : >=- GT : > |
watchdogs.threshold | Body | Long | Thresholds to watch |
watchdogs.duration | Body | Long | Watchlist duration - Unit: minutes |
watchdogs.createdYmdt | Body | DateTime | Created date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"watchdogs": [
{
"watchdogId": "b3901f17-9971-4d1e-8a81-8448cf533dc7",
"metricName": "DATABASE_STATUS",
"comparisonOperator": "LE",
"threshold": 0,
"duration": 5,
"createdYmdt": "2023-02-20T13:34:13+09:00",
"updatedYmdt": "2023-02-20T13:34:13+09:00"
}
]
}
POST /v1.0/notification-groups/{notificationGroupId}/watchdogs
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationWatchdog.Create | Create a watch setting |
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupId | URL | UUID | O | Notification group identifier |
metricName | Body | Enum | O | Performance metrics to watch - For the performance metrics you can set, see Viewing the performance metrics list. |
comparisonOperator | Body | Enum | O | How to compare watchlists - LE : <=- LT : <- GE : >=- GT : > |
threshold | Body | Long | O | Thresholds to watch |
duration | Body | Long | O | Watchlist duration - Unit: minutes |
{
"metricName": "DATABASE_STATUS",
"comparisonOperator": "LE",
"threshold": 0,
"duration": 5
}
Name | Type | Format | Description |
---|---|---|---|
watchdogId | Body | UUID | Identifier of the watch setting |
PUT /v1.0/notification-groups/{notificationGroupId}/watchdogs/{watchdogId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationWatchdog.Modify | Modify watch settings |
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupId | URL | UUID | O | Notification group identifier |
watchdogId | URL | UUID | O | Identifier of the watch setting |
metricName | Body | Enum | O | Performance metrics to watch - For the performance metrics you can set, see Viewing the performance metrics list. |
comparisonOperator | Body | Enum | O | How to compare watchlists - LE : <=- LT : <- GE : >=- GT : > |
threshold | Body | Long | O | Thresholds to watch |
duration | Body | Long | O | Watchlist duration - Unit: minutes |
{
"metricName": "DATABASE_STATUS",
"comparisonOperator": "LE",
"threshold": 0,
"duration": 10
}
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
DELETE /v1.0/notification-groups/{notificationGroupId}/watchdogs/{watchdogId}
Permission Name | Description |
---|---|
RDSforPostgreSQL:NotificationWatchdog.Delete | Deleting a watch setting |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
notificationGroupId | URL | UUID | O | Notification group identifier |
watchdogId | URL | UUID | O | Identifier of the watch setting |
This API does not return a response body.
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
}
}
GET /v1.0/metrics
Permission Name | Description |
---|---|
RDSforPostgreSQL:Metric.List | View stats |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
metrics | Body | Array | List of performance metrics |
metrics.metricName | Body | Enum | Performance metric types |
metrics.unit | Body | String | Measure unit |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"metrics": [
{
"metricName": "CPU_USAGE",
"unit": "%"
}
]
}
GET /v1.0/metric-statistics
Permission Name | Description |
---|---|
RDSforPostgreSQL:Metric.List | View stats |
Name | Type | Format | Required | Description |
---|---|---|---|---|
dbInstanceId | Query | UUID | O | DB instance identifier |
metricNames | Query | Array | O | List of performance metrics to look up - Minimum length: 1 |
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) |
interval | Query | Number | X | View interval - Unit: minutes - Default: Automatically selects the appropriate value based on start/end dates |
Name | Type | Format | Description |
---|---|---|---|
metricStatistics | Body | Array | Statistics information list |
metricStatistics.metricName | Body | Enum | Performance metric types |
metricStatistics.unit | Body | String | Measure unit |
metricStatistics.values | Body | Array | Measure values |
metricStatistics.values.timestamp | Body | Timestamp | Measure time |
metricStatistics.values.value | Body | Object | Measure value |
{
"metricStatistics": [
{
"metricName": "DATABASE_STATUS",
"unit": "",
"values": [
[
1679298540,
"1"
],
[
1679298600,
"1"
],
[
1679298660,
"1"
]
]
}
]
}
GET /v1.0/events
Permission Name | Description |
---|---|
RDSforPostgreSQL:Event.List | View the list of events |
This API does not require a request body.
Name | Type | Format | Required | Description |
---|---|---|---|---|
page | Query | Number | O | Page to retrieve - Minimum value: 1 |
size | Query | Number | O | Page size to retrieve - Minimum value: 1 - Maximum value: 100 |
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 - BACKUP : Backup- DB_INSTANCE : DB instance- DB_SECURITY_GROUP : DB security group- JOB: Job - TENANT : Tenant- MONITORING : Monitoring |
sourceId | Query | String | X | Event target resource identifier |
keyword | Query | String | X | String keyword in event message |
Name | Type | Format | Description |
---|---|---|---|
totalCounts | Body | Number | Total number of events |
events | Body | Array | Events |
events.eventCategoryType | Body | Enum | Event category type |
events.eventCode | Body | Enum | Occurred event type - See Events for a detailed description. |
events.sourceId | Body | String | Event source identifier |
events.sourceName | Body | String | Name to identify event sources |
events.messages | Body | Array | Event messages |
events.messages.langCode | Body | String | Language code |
events.messages.message | Body | String | Event Message |
events.eventYmdt | Body | DateTime | Event occurred date and time (YYYY-MM-DDThh:mm:ss.SSSTZD) |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"totalCounts": 28,
"events": [
{
"eventCategoryType": "INSTANCE",
"eventCode": "INSTC_02_01",
"sourceId": "76f00947-356e-4a20-8922-428368cc45ed",
"sourceName": "db-instance",
"messages": [
{
"langCode": "EN",
"message": "DB instance started"
},
{
"langCode": "JA",
"message": "DBインスタンスの起動"
},
{
"langCode": "KO",
"message": "DB 인스턴스 시작"
},
{
"langCode": "ZH",
"message": "DB instance started"
}
],
"eventYmdt": "2023-03-20T16:31:59+09:00"
}
]
}
GET /v1.0/event-codes
Permission Name | Description |
---|---|
RDSforPostgreSQL:Event.List | View the list of events |
This API does not require a request body.
Name | Type | Format | Description |
---|---|---|---|
eventCodes | Body | Array | Event Codes |
eventCodes.eventCode | Body | Enum | Event Code |
eventCodes.eventCategoryType | Body | Enum | Event category type |
{
"header": {
"resultCode": 0,
"resultMessage": "SUCCESS",
"isSuccessful": true
},
"eventCodes": [
{
"eventCode": "DB_INSTANCE_02_01",
"eventCategoryType": "DB_INSTANCE"
}
]
}