API v1.0 ガイド - NHN Cloud 使用ガイド

Database > RDS for PostgreSQL > API 가이드

리전	엔드포인트
한국(판교) 리전	https://kr1-rds-postgres.api.nhncloudservice.com

인증 및 권한

API를 사용하려면 Public API > API 호출 및 인증을 통해 발급 받은 Bearer 유형의 토큰이 필요합니다. 발급 받은 토큰은 Appkey와 함께 요청 Header에 포함해야 합니다.

이름	종류	형식	필수	설명
X-TC-APP-KEY	Header	String	O	RDS for PostgreSQL 서비스의 Appkey 또는 프로젝트 통합 Appkey
X-NHN-AUTHORIZATION	Header	String	O	Public API로 발급 받은 Bearer 유형 토큰

또한 프로젝트 권한에 따라 호출할 수 있는 API가 제한됩니다. RDS for PostgreSQL ADMIN, RDS for PostgreSQL VIEWER 역할에는 아래처럼 기본 권한이 부여돼 있고 프로젝트 내 역할 그룹 관리 메뉴에서 필요한 권한만 부여할 수 있습니다.

RDS for PostgreSQL ADMIN 역할은 API 실행에 필요한 모든 권한이 부여됩니다.
RDS for PostgreSQL VIEWER 역할은 정보를 조회하는 권한만 부여됩니다.
- DB 인스턴스를 생성, 수정, 삭제하거나, DB 인스턴스를 대상으로 하는 어떠한 기능도 사용할 수 없습니다.
- 단, 알림 그룹과 사용자 그룹 관련된 기능은 사용할 수 있습니다.

API 요청 시 인증에 실패하거나 권한이 없으면 다음과 같은 오류가 발생합니다.

resultCode	resultMessage	설명
80401	Unauthorized	인증에 실패했습니다.
80403	Forbidden	권한이 없습니다.

응답 공통 정보

모든 API 요청에 200 OK로 응답합니다. 자세한 응답 결과는 응답 본문의 헤더를 참고합니다.

응답 본문

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

필드

이름	자료형	설명
resultCode	Number	결과 코드(성공: 0, 그 외: 실패)
resultMessage	String	결과 메시지
successful	Boolean	성공 여부

DB 버전

DB 버전	생성 가능 여부
POSTGRESQL_V146	O

ENUM 유형의 dbVersion 필드에 대해 해당 값을 사용할 수 있습니다.
버전에 따라 생성이 불가능하거나, 복원이 불가능한 경우가 있을 수 있습니다.

DB 버전 목록 보기

GET /v1.0/db-versions

필요 권한

권한명	설명
RDSforPostgreSQL:DbVersion.List	DB 버전 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
dbVersions	Body	Array	DB 버전 목록
dbVersions.dbVersion	Body	String	DB 버전
dbVersions.dbVersionName	Body	String	DB 버전명
dbVersions.restorableFromObs	Body	Boolean	오브젝트 스토리지로부터 복원 가능 여부

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbVersions": [
        {
            "dbVersion": "POSTGRESQL_V146",
            "dbVersionName": "PostgreSQL V14.6",
            "restorableFromObs": true
        }
    ]
}

DB 인스턴스 사양

DB 인스턴스 사양 목록 보기

GET /v1.0/db-flavors

필요 권한

권한명	설명
RDSforPostgreSQL:DbFlavor.List	DB 인스턴스 사양 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
dbFlavors	Body	Array	DB 인스턴스 사양 목록
dbFlavors.dbFlavorId	Body	UUID	DB 인스턴스 사양의 식별자
dbFlavors.dbFlavorName	Body	String	DB 인스턴스 사양 이름
dbFlavors.ram	Body	Number	메모리 용량(MB)
dbFlavors.vcpus	Body	Number	CPU 코어 수

예시

{
    "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

필요 권한

권한명	설명
RDSforPostgreSQL:Project.Get	프로젝트 정보 조회

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
regions	Body	Array	리전 목록
regions.regionCode	Body	Enum	리전 코드 - `KR1`: 한국(판교) 리전
regions.isEnabled	Body	Boolean	리전의 활성화 여부

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "regions": [
        {
            "regionCode": "KR1",
            "isEnabled": true
        }
    ]
}

프로젝트 멤버 목록 보기

GET /v1.0/project/members

필요 권한

권한명	설명
RDSforPostgreSQL:Project.Get	프로젝트 정보 조회

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
members	Body	Array	프로젝트 멤버 목록
members.memberId	Body	UUID	프로젝트 멤버의 식별자
members.memberName	Body	String	프로젝트 멤버의 이름
members.emailAddress	Body	String	프로젝트 멤버의 이메일 주소
members.phoneNumber	Body	String	프로젝트 멤버의 전화번호

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "members": [
        {
            "memberId": "1b1d3627-507a-49ea-8cb7-c86dfa9caa58",
            "memberName": "홍길동",
            "emailAddress": "gildong.hong@nhn.com",
            "phoneNumber": "+821012345678"
        }
    ]
}

네트워크

서브넷 목록 보기

GET /v1.0/network/subnets

필요 권한

권한명	설명
RDSforPostgreSQL:Network.List	서브넷 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
subnets	Body	Array	서브넷 목록
subnets.subnetId	Body	UUID	서브넷의 식별자
subnets.subnetName	Body	String	서브넷을 식별할 수 있는 이름
subnets.subnetCidr	Body	String	서브넷의 CIDR
subnets.usingGateway	Body	Boolean	게이트웨이 사용 여부
subnets.availableIpCount	Body	Number	사용 가능한 IP 수

예시

{
    "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

필요 권한

권한명	설명
RDSforPostgreSQL:Storage.List	스토리지 유형 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
storageTypes	Body	Array	스토리지 유형 목록

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "storageTypes": [
        "General SSD",
        "General HDD"
    ]
}

작업 정보

작업 정보 상세 보기

GET /v1.0/jobs/{jobId}

필요 권한

권한명	설명
RDSforPostgreSQL:Job.Get	작업 정보 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
jobId	URL	UUID	O	작업의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	작업의 식별자
jobStatus	Body	Enum	작업의 현재 상태 - `PREPARING`: 작업이 준비 중인 경우 - `READY`: 작업이 준비 완료된 경우 - `RUNNING`: 작업이 진행 중인 경우 - `COMPLETED`: 작업이 완료된 경우 - `REGISTERED`: 작업이 등록된 경우 - `WAIT_TO_REGISTER`: 작업 등록 대기 중인 경우 - `INTERRUPTED`: 작업 진행 중 인터럽트가 발생한 경우 - `CANCELED`: 작업이 취소된 경우 - `FAILED`: 작업이 실패한 경우 - `ERROR`: 작업 진행 중 오류가 발생한 경우 - `DELETED`: 작업이 삭제된 경우 - `FAIL_TO_READY`: 작업 준비에 실패한 경우
resourceRelations	Body	Array	연관 리소스 목록
resourceRelations.resourceType	Body	Enum	연관 리소스 유형 - `DB_INSTANCE`: DB 인스턴스 - `DB_INSTANCE_GROUP`: DB 인스턴스 그룹 - `DB_SECURITY_GROUP`: DB 보안 그룹 - `PARAMETER_GROUP`: 파라미터 그룹 - `BACKUP`: 백업 - `TENANT`: 테넌트
resourceRelations.resourceId	Body	UUID	연관 리소스의 식별자
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(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"
}

DB 인스턴스 그룹

DB 인스턴스 그룹 목록 보기

GET /v1.0/db-instance-groups

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceGroup.List	DB 인스턴스 그룹 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
dbInstanceGroups	Body	Array	DB 인스턴스 그룹 목록
dbInstanceGroups.dbInstanceGroupId	Body	UUID	DB 인스턴스 그룹의 식별자
dbInstanceGroups.dbInstanceGroupStatus	Body	Enum	DB 인스턴스 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
dbInstanceGroups.replicationType	Body	Enum	DB 인스턴스 그룹의 복제 형태 - `STANDALONE`: 단일
dbInstanceGroups.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbInstanceGroups.updatedYmdt	Body	DateTime	수정 일시(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"
        }
    ]
}

DB 인스턴스 그룹 상세 보기

GET /v1.0/db-instance-groups/{dbInstanceGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceGroup.Get	DB 인스턴스 그룹 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceGroupId	URL	UUID	O	DB 인스턴스 그룹의 식별자

응답

이름	종류	형식	설명
dbInstanceGroupId	Body	UUID	DB 인스턴스 그룹의 식별자
dbInstanceGroupStatus	Body	Enum	DB 인스턴스 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
replicationType	Body	Enum	DB 인스턴스 그룹의 복제 형태 - `STANDALONE`: 단일 - `HIGH_AVAILABILITY`: 고가용성
dbInstances	Body	Array	DB 인스턴스 그룹에 속한 DB 인스턴스 목록
dbInstances.dbInstanceId	Body	UUID	DB 인스턴스의 식별자
dbInstances.dbInstanceType	Body	Enum	DB 인스턴스의 역할 타입 - `MASTER`: 마스터 - `FAILED_MASTER`: 장애 조치된 마스터 - `CANDIDATE_MASTER`: 예비 마스터 - `READ_ONLY_SLAVE`: 읽기 복제본
dbInstances.dbInstanceStatus	Body	Enum	DB 인스턴스의 현재 상태
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(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"
}

DB 인스턴스

DB 인스턴스 상태

상태	설명
`AVAILABLE`	DB 인스턴스가 사용 가능한 경우
`BEFORE_CREATE`	DB 인스턴스 생성 전인 경우
`STORAGE_FULL`	DB 인스턴스의 용량이 부족한 경우
`FAIL_TO_CREATE`	DB 인스턴스 생성에 실패한 경우
`FAIL_TO_CONNECT`	DB 인스턴스 연결에 실패한 경우
`REPLICATION_STOP`	DB 인스턴스의 복제가 중단된 경우
`REPLICATION_DELAY`	DB 인스턴스의 복제가 지연 중인 경우
`FAILOVER`	고가용성 DB 인스턴스의 장애 조치가 완료된 경우
`SHUTDOWN`	DB 인스턴스가 중지된 경우
`DELETED`	DB 인스턴스가 삭제된 경우

DB 인스턴스 진행 상태

상태	설명
`APPLYING_DB_INSTANCE_HBA_RULE`	접근 제어 규칙 적용 중
`APPLYING_PARAMETER_GROUP`	파라미터 그룹 적용 중
`BACKING_UP`	백업 중
`CANCELING`	취소 중
`CREATING`	생성 중
`CREATING_DATABASE`	데이터베이스 생성 중
`CREATING_USER`	사용자 생성 중
`DELETING`	삭제 중
`DELETING_DATABASE`	데이터베이스 삭제 중
`DELETING_USER`	사용자 삭제 중
`FAILING_OVER`	장애 조치 중
`MIGRATING`	마이그레이션 중
`MODIFYING`	수정 중
`OCCUPIED`	점유 중
`PREPARING`	준비 중
`PROMOTING`	승격 중
`PROMOTING_FORCIBLY`	강제 승격 중
`REBUILDING`	재구축 중
`REPAIRING`	복구 중
`REPLICATING`	복제 중
`RESTARTING`	재시작 중
`RESTARTING_FORCIBLY`	강제 재시작 중
`RESTORING`	복원 중
`STARTING`	시작 중
`STOPPING`	정지 중
`SYNCING_DATABASE`	데이터베이스 동기화 중
`SYNCING_USER`	사용자 동기화 중
`UPDATING_USER`	사용자 수정 중
`UPDATING_DATABASE`	데이터베이스 수정 중
`WAIT_MANUAL_CONTROL`	수동 장애 조치 대기 중

DB 인스턴스 목록 보기

GET /v1.0/db-instances

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.List	DB 인스턴스 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
dbInstances	Body	Array	DB 인스턴스 목록
dbInstances.dbInstanceId	Body	UUID	DB 인스턴스의 식별자
dbInstances.dbInstanceGroupId	Body	UUID	DB 인스턴스 그룹의 식별자
dbInstances.dbInstanceName	Body	String	DB 인스턴스를 식별할 수 있는 이름
dbInstances.description	Body	String	DB 인스턴스에 대한 추가 정보
dbInstances.dbVersion	Body	Enum	DB 버전 정보
dbInstances.dbPort	Body	Number	DB 포트
dbInstances.dbInstanceType	Body	Enum	DB 인스턴스의 역할 타입 - `MASTER`: 마스터 - `FAILED_MASTER`: 장애 조치된 마스터 - `CANDIDATE_MASTER`: 예비 마스터 - `READ_ONLY_SLAVE`: 읽기 복제본
dbInstances.dbInstanceStatus	Body	Enum	DB 인스턴스의 현재 상태
dbInstances.progressStatus	Body	Enum	DB 인스턴스의 현재 진행 상태
dbInstances.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbInstances.updatedYmdt	Body	DateTime	수정 일시(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"
        }
    ]
}

DB 인스턴스 상세 보기

GET /v1.0/db-instances/{dbInstanceId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Get	DB 인스턴스 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
dbInstanceId	Body	UUID	DB 인스턴스의 식별자
dbInstanceGroupId	Body	UUID	DB 인스턴스 그룹의 식별자
dbInstanceName	Body	String	DB 인스턴스를 식별할 수 있는 이름
description	Body	String	DB 인스턴스에 대한 추가 정보
dbVersion	Body	Enum	DB 버전 정보
dbPort	Body	Number	DB 포트
dbInstanceType	Body	Enum	DB 인스턴스의 역할 타입 - `MASTER`: 마스터 - `FAILED_MASTER`: 장애 조치된 마스터 - `CANDIDATE_MASTER`: 예비 마스터 - `READ_ONLY_SLAVE`: 읽기 복제본
dbInstanceStatus	Body	Enum	DB 인스턴스의 현재 상태
progressStatus	Body	Enum	DB 인스턴스의 현재 작업 진행 상태
dbFlavorId	Body	UUID	DB 인스턴스 사양의 식별자
parameterGroupId	Body	UUID	DB 인스턴스에 적용된 파라미터 그룹의 식별자
dbSecurityGroupIds	Body	Array	DB 인스턴스에 적용된 DB 보안 그룹의 식별자 목록
notificationGroupIds	Body	Array	DB 인스턴스에 적용된 알림 그룹의 식별자 목록
useDeletionProtection	Body	Boolean	DB 인스턴스 삭제 보호 여부
needToApplyParameterGroup	Body	Boolean	최신 파라미터 그룹 적용 필요 여부
needMigration	Body	Boolean	마이그레이션 필요 여부
osVersion	Body	String	운영체제 버전
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(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"
}

DB 인스턴스 생성하기

POST /v1.0/db-instances

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Create	DB 인스턴스 생성하기

요청

이름	종류	형식	필수	설명
dbInstanceName	Body	String	O	DB 인스턴스를 식별할 수 있는 이름
description	Body	String	X	DB 인스턴스에 대한 추가 정보
dbFlavorId	Body	UUID	O	DB 인스턴스 사양의 식별자
dbVersion	Body	Enum	O	DB 버전 정보
dbPort	Body	Number	O	DB 포트 - 최솟값: `5432` - 최댓값: `45432`
databaseName	Body	String	O	DB 엔진 내 신규 생성할 데이터베이스명
dbUserName	Body	String	O	DB 엔진 내 신규 생성할 사용자 계정명
dbPassword	Body	String	O	DB 엔진 내 신규 생성할 사용자 계정 암호 - 최소 길이: `4` - 최대 길이: `16`
parameterGroupId	Body	UUID	O	파라미터 그룹의 식별자
dbSecurityGroupIds	Body	Array	X	DB 보안 그룹의 식별자 목록
useDeletionProtection	Body	Boolean	X	삭제 보호 여부 - 기본값: `false`
useDefaultNotification	Body	Boolean	X	기본 알림 사용 여부 - 기본값: `false`
useHighAvailability	Body	Boolean	X	고가용성 사용 여부
pingInterval	Body	Number	X	고가용성 사용 시 Ping 간격(초) - 최솟값: `1` - 최댓값: `600`
failoverReplWaitingTime	Body	Number	X	고가용성 사용 시 장애 조치 대기 시간 - 최솟값: `-1` - -1로 설정 시, 복제 지연 해소까지 계속해서 대기합니다.
network	Body	Object	O	네트워크 정보 객체
network.subnetId	Body	UUID	O	서브넷의 식별자
network.usePublicAccess	Body	Boolean	X	외부 접속 가능 여부 - 기본값: `false`
network.availabilityZone	Body	Enum	X	DB 인스턴스를 생성할 가용성 영역 - 예시: `kr-pub-a` - 기본값: `임의의 가용성 영역`
storage	Body	Object	O	스토리지 정보 객체
storage.storageType	Body	Enum	O	데이터 스토리지 유형 - 예시: `General SSD`
storage.storageSize	Body	Number	O	데이터 스토리지 크기(GB) - 최솟값: `20` - 최댓값: `2048`
backup	Body	Object	O	백업 정보 객체
backup.backupPeriod	Body	Number	O	백업 보관 기간(일) - 최솟값: `0` - 최댓값: `730`
backup.backupRetryCount	Body	Number	X	백업 재시도 횟수 - 기본값: `0` - 최솟값: `0` - 최댓값: `10`
backup.backupSchedules	Body	Array	X	백업 스케줄 목록
backup.backupSchedules.backupWndBgnTime	Body	String	O	백업 시작 시간 - 예시: `00:00:00`
backup.backupSchedules.backupWndDuration	Body	Enum	O	백업 윈도우 백업 시작 시간부터 설정된 기간 안에 자동 백업이 실행됩니다. - `HALF_AN_HOUR`: 30분 - `ONE_HOUR`: 1시간 - `ONE_HOUR_AND_HALF`: 1시간 30분 - `TWO_HOURS`: 2시간 - `TWO_HOURS_AND_HALF`: 2시간 30분 - `THREE_HOURS`: 3시간

예시

{
    "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"
            }
        ]
    }
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 수정하기

PUT /v1.0/db-instances/{dbInstanceId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
dbInstanceName	Body	String	X	DB 인스턴스를 식별할 수 있는 이름
description	Body	String	X	DB 인스턴스에 대한 추가 정보
dbPort	Body	Number	X	DB 포트 - 최솟값: `5432` - 최댓값: `45432`
dbFlavorId	Body	UUID	X	DB 인스턴스 사양의 식별자
parameterGroupId	Body	UUID	X	파라미터 그룹의 식별자
dbSecurityGroupIds	Body	Array	X	DB 보안 그룹의 식별자 목록
executeBackup	Body	Boolean	X	현재 시점 백업 진행 여부 - 기본값: `false`

예시

{
    "dbInstanceName": "db-instance2",
    "description": "description2",
    "dbPort": 25432,
    "dbSecurityGroupIds": [],
    "executeBackup": true
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

고가용성 정보 조회

GET /v1.0/db-instances/{dbInstanceId}/high-availability

필요 권한

권한명	설명
RDSforPostgreSQL:HighAvailability.Get	고가용성 정보 조회

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
haStatus	Body	Boolean	고가용성 상태 - `CREATED`: 생성됨 - `STABLE`: 정상 - `DISABLE_REPLICATION_DELAY`: 복제 지연으로 인한 장애 조치 정지 - `PAUSING`: 일시 중지 중 - `PAUSED`: 일시 중지 - `PAUSED_DUE_TO_TASK`: 작업으로 인한 일시 중지 - `FAILOVER_STARTED`: 장애 조치 시작 - `FAILOVER_FAILED`: 장애 조치 실패 - `FAILOVER_COMPLETED`: 장애 조치 완료 - `DELETED`: 삭제됨
pingInterval	Body	Number	고가용성 사용 시 Ping 간격(초) - 최솟값: `1` - 최댓값: `600`
failoverReplWaitingTime	Body	Number	고가용성 사용 시 장애 조치 대기 시간 - 최솟값: `-1` - -1로 설정 시, 복제 지연 해소까지 계속해서 대기합니다.

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "useHighAvailability": true,
    "haStatus": "STABLE",
    "pingInterval": 3,
    "failoverReplWaitingTime": 60
}

고가용성 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/high-availability

필요 권한

권한명	설명
RDSforPostgreSQL:HighAvailability.Modify	고가용성 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
useHighAvailability	Body	Boolean	O	고가용성 사용 여부
pingInterval	Body	Number	X	고가용성 사용 시 Ping 간격(초) - 최솟값: `1` - 최댓값: `600`
failoverReplWaitingTime	Body	Number	X	고가용성 사용 시 장애 조치 대기 시간 - 최솟값: `-1` - -1로 설정 시, 복제 지연 해소까지 계속해서 대기합니다.

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

고가용성 다시 시작하기

POST /v1.0/db-instances/{dbInstanceId}/high-availability/resume

필요 권한

권한명	설명
RDSforPostgreSQL:HighAvailability.Resume	고가용성 다시 시작하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

고가용성 일시 중지하기

POST /v1.0/db-instances/{dbInstanceId}/high-availability/pause

필요 권한

권한명	설명
RDSforPostgreSQL:HighAvailability.Pause	고가용성 일시 중지하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

고가용성 복구하기

POST /v1.0/db-instances/{dbInstanceId}/high-availability/repair

필요 권한

권한명	설명
RDSforPostgreSQL:HighAvailability.Repair	고가용성 복구하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

고가용성 분리하기

POST /v1.0/db-instances/{dbInstanceId}/high-availability/split

필요 권한

권한명	설명
RDSforPostgreSQL:HighAvailability.Split	고가용성 분리하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 스토리지 정보 조회

GET /v1.0/db-instances/{dbInstanceId}/storage-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Get	DB 인스턴스 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
storageType	Body	Enum	데이터 스토리지 유형
storageSize	Body	Number	데이터 스토리지 크기(GB)
storageStatus	Body	Enum	데이터 스토리지의 현재 상태 - `DETACHED`: 부착되지 않음 - `ATTACHED`: 부착됨 - `DELETED`: 삭제됨

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "storageType": "General SSD",
    "storageSize": 20,
    "storageStatus": "ATTACHED"
}

DB 인스턴스 스토리지 정보 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/storage-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
storageSize	Body	Number	O	데이터 스토리지 크기(GB) - 최솟값: 현재값 - 최댓값: `2048`

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 네트워크 정보 조회

GET /v1.0/db-instances/{dbInstanceId}/network-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Get	DB 인스턴스 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
availabilityZone	Body	Enum	DB 인스턴스를 생성할 가용성 영역
subnet	Body	Object	서브넷 객체
subnet.subnetId	Body	UUID	서브넷의 식별자
subnet.subnetName	Body	UUID	서브넷을 식별할 수 있는 이름
subnet.subnetCidr	Body	UUID	서브넷의 CIDR
subnet.publicAccessible	Body	Boolean	외부 접속 가능 여부
endPoints	Body	Array	접속 정보 목록
endPoints.domain	Body	String	도메인
endPoints.ipAddress	Body	String	IP 주소
endPoints.endPointType	Body	Enum	접속 정보 유형 -`EXTERNAL`: 외부 접속 도메인 -`INTERNAL`: 내부 접속 도메인 -`PUBLIC`: (Deprecated) 외부 접속 도메인 -`PRIVATE`: (Deprecated) 내부 접속 도메인

예시

{
    "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"
        }
    ]
}

DB 인스턴스 네트워크 정보 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/network-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
usePublicAccess	Body	Boolean	O	외부 접속 가능 여부

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 백업 정보 조회

GET /v1.0/db-instances/{dbInstanceId}/backup-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Get	DB 인스턴스 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
backupPeriod	Body	Number	백업 보관 기간(일)
backupRetryCount	Body	Number	백업 재시도 횟수
backupSchedules	Body	Array	백업 스케줄 목록
backupSchedules.backupWndBgnTime	Body	String	백업 시작 시간
backupSchedules.backupWndDuration	Body	Enum	백업 윈도우 백업 시작 시간부터 설정된 기간 안에 자동 백업이 실행됩니다. - `HALF_AN_HOUR`: 30분 - `ONE_HOUR`: 1시간 - `ONE_HOUR_AND_HALF`: 1시간 30분 - `TWO_HOURS`: 2시간 - `TWO_HOURS_AND_HALF`: 2시간 30분 - `THREE_HOURS`: 3시간

예시

{
    "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"
        }
    ]
}

DB 인스턴스 백업 정보 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/backup-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
backupPeriod	Body	Number	X	백업 보관 기간(일) - 최솟값: `0` - 최댓값: `730`
backupRetryCount	Body	Number	X	백업 재시도 횟수 - 최솟값: `0` - 최댓값: `10`
backupSchedules	Body	Array	X	백업 스케줄 목록
backupSchedules.backupWndBgnTime	Body	String	O	백업 시작 시간 - 예시: `00:00:00`
backupSchedules.backupWndDuration	Body	Enum	O	백업 윈도우 백업 시작 시간부터 설정된 기간 안에 자동 백업이 실행됩니다. - `HALF_AN_HOUR`: 30분 - `ONE_HOUR`: 1시간 - `ONE_HOUR_AND_HALF`: 1시간 30분 - `TWO_HOURS`: 2시간 - `TWO_HOURS_AND_HALF`: 2시간 30분 - `THREE_HOURS`: 3시간

예시

{
    "backupPeriod": 5,
    "backupSchedules": [
        {
            "backupWndBgnTime": "01:00:00",
            "backupWndDuration": "TWO_HOURS",
            "backupRetryExpireTime": "03:00:00"
        }
    ]
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 복원 정보 조회

GET /v1.0/db-instances/{dbInstanceId}/restoration-info

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Get	DB 인스턴스 상세 보기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
oldestRestorableYmdt	Body	DateTime	가장 오래된 복원 가능한 시간
latestRestorableYmdt	Body	DateTime	가장 최신의 복원 가능한 시간
restorableBackups	Body	Array	복원 가능한 백업 목록
restorableBackups.backup	Body	Object	백업 정보 객체
restorableBackups.backup.backupId	Body	UUID	백업의 식별자
restorableBackups.backup.backupName	Body	String	백업 이름
restorableBackups.backup.backupSize	Body	Number	백업 크기
restorableBackups.backup.backupType	Body	Enum	백업 유형 - `AUTO`: 자동 - `MANUAL`: 수동
restorableBackups.backup.backupStatus	Body	Enum	백업 상태 - `BACKING_UP`: 백업 중인 경우 - `COMPLETED`: 백업이 완료된 경우 - `DELETING`: 백업이 삭제 중인 경우 - `DELETED`: 백업이 삭제된 경우 - `ERROR`: 오류가 발생한 경우
restorableBackups.backup.dbInstanceId	Body	UUID	원본 DB 인스턴스의 식별자
restorableBackups.backup.dbInstanceName	Body	String	원본 DB 인스턴스의 이름
restorableBackups.backup.dbVersion	Body	String	DB 버전 정보
restorableBackups.backup.failoverCount	Body	Number	장애 조치 횟수
restorableBackups.backup.walFileName	Body	String	WAL 로그 파일 이름
restorableBackups.backup.createdYmdt	Body	DateTime	백업 생성 일시
restorableBackups.backup.updatedYmdt	Body	DateTime	백업 갱신 일시
restorableBackups.backup.startYmdt	Body	DateTime	백업 시작 일시
restorableBackups.backup.completedYmdt	Body	DateTime	백업 완료 일시

예시

{
    "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"
            }
        }
    ]
}

DB 인스턴스 복원하기

GET /v1.0/db-instances/{dbInstanceId}/restore

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Restore	DB 인스턴스 복원하기

공통 요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
restore	Body	Object	O	복원 정보 객체
restore.restoreType	Body	Enum	O	복원 타입 종류 - `TIMESTAMP`: 복원 가능한 시간 이내의 시간을 이용한 시점 복원 타입 - `BACKUP`: 기존에 생성한 백업을 이용한 복원 타입
dbInstanceName	Body	String	O	DB 인스턴스를 식별할 수 있는 이름
description	Body	String	X	DB 인스턴스에 대한 추가 정보
dbFlavorId	Body	UUID	O	DB 인스턴스 사양의 식별자
dbPort	Body	Number	O	DB 포트 - 최솟값: `3306` - 최댓값: `43306`
parameterGroupId	Body	UUID	O	파라미터 그룹의 식별자
dbSecurityGroupIds	Body	Array	X	DB 보안 그룹의 식별자 목록
userGroupIds	Body	Array	X	사용자 그룹의 식별자 목록
useDefaultNotification	Body	Boolean	X	기본 알림 사용 여부 - 기본값: `false`
useDeletionProtection	Body	Boolean	X	삭제 보호 여부 기본값: `false`
useHighAvailability	Body	Boolean	X	고가용성 사용 여부 - 기본값: `false`
pingInterval	Body	Number	X	고가용성 사용 시 Ping 간격(초) - 기본값: `3`최솟값: `1` - 최댓값: `600`
failoverReplWaitingTime	Body	Number	X	고가용성 사용 시 장애 조치 대기 시간 - 최솟값: `-1` - -1로 설정 시, 복제 지연 해소까지 계속해서 대기합니다.
network	Body	Object	O	네트워크 정보 객체
network.subnetId	Body	UUID	O	서브넷의 식별자
network.usePublicAccess	Body	Boolean	X	외부 접속 가능 여부 - 기본값: `false`
network.availabilityZone	Body	Enum	X	DB 인스턴스를 생성할 가용성 영역 - 예시: `kr-pub-a` - 기본값: `임의의 가용성 영역`
storage	Body	Object	O	스토리지 정보 객체
storage.storageType	Body	Enum	O	데이터 스토리지 타입 - 예시: `General SSD`
storage.storageSize	Body	Number	O	데이터 스토리지 크기(GB) - 최솟값: `20` - 최댓값: `2048`
backup	Body	Object	O	백업 정보 객체
backup.backupPeriod	Body	Number	O	백업 보관 기간(일) - 최솟값: `0` - 최댓값: `730`
backup.backupRetryCount	Body	Number	X	백업 재시도 횟수 - 기본값: `0` - 최솟값: `0` - 최댓값: `10`
backup.backupSchedules	Body	Array	O	백업 스케줄 목록
backup.backupSchedules.backupWndBgnTime	Body	String	X	백업 시작 시각 - 예시: `00:00:00` - 기본값: 원본 DB 인스턴스 값
backup.backupSchedules.backupWndDuration	Body	Enum	X	백업 Duration 백업 시작 시각부터 Duration 안에 자동 백업이 실행됩니다. - `HALF_AN_HOUR`: 30분 - `ONE_HOUR`: 1시간 - `ONE_HOUR_AND_HALF`: 1시간 30분 - `TWO_HOURS`: 2시간 - `TWO_HOURS_AND_HALF`: 2시간 30분 - `THREE_HOURS`: 3시간 - 기본값: 원본 DB 인스턴스 값

Timestamp를 이용한 시점 복원 시 요청(restoreType이 `TIMESTAMP`인 경우)

이름	종류	형식	필수	설명
restore.restoreYmdt	Body	DateTime	O	DB 인스턴스 복원 시간.(YYYY-MM-DDThh:mm:ss.SSSTZD) 복원 정보 조회로 조회한 가장 최신의 복원 가능한 시간 이전에 대해서만 복원이 가능하다.

예시

{
  "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"
      }
    ]
  }
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 삭제 보호 설정 변경하기

PUT /v1.0/db-instances/{dbInstanceId}/deletion-protection

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
useDeletionProtection	Body	Boolean	O	삭제 보호 여부

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

DB 인스턴스 삭제하기

DELETE /v1.0/db-instances/{dbInstanceId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Delete	DB 인스턴스 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 재시작하기

POST /v1.0/db-instances/{dbInstanceId}/restart

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Restart	DB 인스턴스 재시작하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
useOnlineFailover	Body	Boolean	X	장애 조치를 이용한 재시작 여부 고가용성을 사용 중인 DB 인스턴스에서만 사용 가능합니다. - 기본값: `false`
executeBackup	Body	Boolean	X	현재 시점 백업 진행 여부 - 기본값: `false`

예시

{
    "executeBackup": true
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 강제 재시작하기

POST /v1.0/db-instances/{dbInstanceId}/force-restart

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.ForceRestart	DB 인스턴스 강제 재시작하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

DB 인스턴스 시작하기

POST /v1.0/db-instances/{dbInstanceId}/start

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Start	DB 인스턴스 시작하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 정지하기

POST /v1.0/db-instances/{dbInstanceId}/stop

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Start	DB 인스턴스 시작하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 백업하기

POST /v1.0/db-instances/{dbInstanceId}/backup

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Backup	DB 인스턴스 백업하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
backupName	Body	String	O	백업을 식별할 수 있는 이름

예시

{
    "backupName": "backup"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 백업 후 내보내기

POST /v1.0/db-instances/{dbInstanceId}/backup-to-object-storage

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.BackupToObjectStorage	백업 후 백업 파일 오브젝트 스토리지로 내보내기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
tenantId	Body	String	O	백업이 저장될 오브젝트 스토리지의 테넌트 ID
username	Body	String	O	NHN Cloud 계정 또는 IAM 계정 ID
password	Body	String	O	백업이 저장될 오브젝트 스토리지의 API 비밀번호
targetContainer	Body	String	O	백업이 저장될 오브젝트 스토리지의 컨테이너
objectPath	Body	String	O	컨테이너에 저장될 백업의 경로

예시

{
    "tenantId": "399631c404744dbbb18ce4fa2dc71a5a",
    "username": "gildong.hong@nhn.com",
    "password": "password",
    "targetContainer": "/container",
    "objectPath": "/backups/backup_file"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 최신 파라미터 그룹 적용하기

POST /v1.0/db-instances/{dbInstanceId}/apply-recent-parameter-group

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
executeBackup	Body	Boolean	X	현재 시점 백업 진행 여부 - 기본값: `false`

예시

{
  "executeBackup": true
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 복제하기

POST /v1.0/db-instances/{dbInstanceId}/replicate

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Replicate	DB 인스턴스 복제하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
dbInstanceName	Body	String	O	DB 인스턴스를 식별할 수 있는 이름
description	Body	String	X	DB 인스턴스에 대한 추가 정보
dbFlavorId	Body	UUID	X	DB 인스턴스 사양의 식별자 - 기본값: 원본 DB 인스턴스 값
dbPort	Body	Number	X	DB 포트 - 기본값: 원본 DB 인스턴스 값 - 최솟값: `5432` - 최댓값: `45432`
parameterGroupId	Body	UUID	X	파라미터 그룹의 식별자 - 기본값: 원본 DB 인스턴스 값
dbSecurityGroupIds	Body	Array	X	DB 보안 그룹의 식별자 목록 - 기본값: 원본 DB 인스턴스 값
userGroupIds	Body	Array	X	사용자 그룹의 식별자 목록
useDefaultNotification	Body	Boolean	X	기본 알림 사용 여부 - 기본값: `false`
useDeletionProtection	Body	Boolean	X	삭제 보호 여부 - 기본값: `false`
network	Body	Object	X	네트워크 정보 객체
network.usePublicAccess	Body	Boolean	X	외부 접속 가능 여부 - 기본값: `false`
network.availabilityZone	Body	Enum	X	DB 인스턴스를 생성할 가용성 영역 - 예시: `kr-pub-a` - 기본값: `임의의 가용성 영역`
storage	Body	Object	X	스토리지 정보 객체
storage.storageType	Body	Enum	X	데이터 스토리지 유형 - 예시: `General SSD`
storage.storageSize	Body	Number	X	데이터 스토리지 크기(GB) - 기본값: 원본 DB 인스턴스 값 - 최솟값: `20` - 최댓값: `2048`
backup	Body	Object	X	백업 정보 객체
backup.backupPeriod	Body	Number	X	백업 보관 기간(일) - 기본값: 원본 DB 인스턴스 값 - 최솟값: `0` - 최댓값: `730`
backup.backupRetryCount	Body	Number	X	백업 재시도 횟수 - 기본값: 원본 DB 인스턴스 값 - 최솟값: `0` - 최댓값: `10`
backup.backupSchedules	Body	Array	X	백업 스케줄 목록
backup.backupSchedules.backupWndBgnTime	Body	String	X	백업 시작 시각 - 예시: `00:00:00` - 기본값: 원본 DB 인스턴스 값
backup.backupSchedules.backupWndDuration	Body	Enum	X	백업 Duration 백업 시작 시각부터 Duration 안에 자동 백업이 실행됩니다. - `HALF_AN_HOUR`: 30분 - `ONE_HOUR`: 1시간 - `ONE_HOUR_AND_HALF`: 1시간 30분 - `TWO_HOURS`: 2시간 - `TWO_HOURS_AND_HALF`: 2시간 30분 - `THREE_HOURS`: 3시간 - 기본값: 원본 DB 인스턴스 값

예시

{
    "dbInstanceName": "db-instance-replicate",
    "description": "description",
    "dbPort": 15432,
    "storage": {
        "storageSize": 100
    }
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 승격하기

POST /v1.0/db-instances/{dbInstanceId}/promote

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Promote	DB 인스턴스 승격하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 > 데이터베이스

데이터베이스 목록 보기

GET /v1.0/db-instances/{dbInstanceId}/databases

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceDatabase.List	DB 인스턴스 내 데이터베이스 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
databases	Body	Array	데이터베이스 목록
databases.databaseId	Body	UUID	데이터베이스의 식별자
databases.databaseName	Body	String	데이터베이스 이름
databases.databaseStatus	Body	Enum	데이터베이스의 현재 상태 - `STABLE`: 생성됨 - `CREATING`: 생성 중 - `MODIFYING`: 수정 중 - `SYNCING`: 동기화 중 - `DELETING`: 삭제 중 - `DELETED`: 삭제됨
databases.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
databases.updatedYmdt	Body	DateTime	수정 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
databases.schemas	Body	Array	데이터베이스 내 스키마 목록
databases.schemas.schemaName	Body	String	스키마 이름

예시

{
    "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

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceDatabase.Create	DB 인스턴스 내 데이터베이스 생성하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
databaseName	Body	String	O	데이터베이스 이름

예시

{
    "databaseName": "database"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

데이터베이스 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/databases/{databaseId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceDatabase.Modify	DB 인스턴스 내 데이터베이스 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
databaseId	URL	UUID	O	데이터베이스의 식별자
databaseName	Body	String	O	데이터베이스 이름
applyHbaRulesImmediately	Body	Boolean	X	연관된 접근 제어 규칙 즉시 적용 여부 - 데이터베이스 이름 변경 시 이전 데이터베이스 이름으로 설정된 접근 제어 규칙이 있으면 변경된 이름으로 반영합니다.

예시

{
    "databaseName": "database-1"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

데이터베이스 삭제하기

DELETE /v1.0/db-instances/{dbInstanceId}/databases/{databaseId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceDatabase.Delete	DB 인스턴스 내 데이터베이스 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
databaseId	URL	UUID	O	데이터베이스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 > 사용자

사용자 목록 보기

GET /v1.0/db-instances/{dbInstanceId}/db-users

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceUser.List	DB 인스턴스 내 사용자 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
dbUsers	Body	Array	DB 사용자 목록
dbUsers.dbUserId	Body	UUID	DB 사용자의 식별자
dbUsers.dbUserName	Body	String	DB 사용자 계정 이름
dbUsers.authorityType	Body	Enum	DB 사용자 권한 유형 - `CRUD`: DML 쿼리 수행 가능한 권한 - `DDL`: DDL 쿼리 수행 가능한 권한
dbUsers.dbUserStatus	Body	Enum	DB 사용자의 현재 상태 - `STABLE`: 생성됨 - `CREATING`: 생성 중 - `MODIFYING`: 수정 중 - `SYNCING`: 동기화 중 - `DELETING`: 삭제 중 - `DELETED`: 삭제됨
dbUsers.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbUsers.updatedYmdt	Body	DateTime	수정 일시(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

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceUser.Create	DB 인스턴스 내 사용자 생성하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
dbUserName	Body	String	O	DB 사용자 계정 이름 - 최소 길이: `1` - 최대 길이: `20`
dbPassword	Body	String	O	DB 사용자 계정 암호 - 최소 길이: `1` - 최대 길이: `100`
authorityType	Body	Enum	O	DB 사용자 권한 유형 - `CRUD`: DML 쿼리 수행 가능한 권한 - `DDL`: DDL 쿼리 수행 가능한 권한
createDefaultHbaRules	Body	Boolean	X	기본 접근 제어 규칙 생성 여부
address	Body	String	X	기본 접근 제어 규칙 생성 시 사용할 접속 주소

예시

{
    "dbUserName": "db-user",
    "dbPassword": "password",
    "authorityType": "CRUD"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

사용자 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/db-users/{dbUserId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceUser.Modify	DB 인스턴스 내 사용자 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
dbUserId	URL	UUID	O	DB 사용자의 식별자
dbUserName	Body	String	X	DB 사용자 계정 이름 - 최소 길이: `1` - 최대 길이: `20`
dbPassword	Body	String	X	DB 사용자 계정 암호 - 최소 길이: `1` - 최대 길이: `100`
authorityType	Body	Enum	X	DB 사용자 권한 유형 - `CRUD`: DML 쿼리 수행 가능한 권한 - `DDL`: DDL 쿼리 수행 가능한 권한
applyHbaRulesImmediately	Body	Boolean	X	연관된 접근 제어 규칙 즉시 적용 여부 - 사용자 계정 이름 변경 시 이전 사용자 계정 이름으로 설정된 접근 제어 규칙이 있으면 변경된 이름으로 반영합니다.

예시

{
    "dbUserName": "db-user-1",
    "dbPassword": "new-password"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

사용자 삭제하기

DELETE /v1.0/db-instances/{dbInstanceId}/db-users/{dbUserId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceUser.Delete	DB 인스턴스 내 사용자 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
dbUserId	URL	UUID	O	DB 사용자의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 인스턴스 > 접근 제어

접근 제어 규칙 목록 보기

GET /v1.0/db-instances/{dbInstanceId}/hba-rules

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceHba.List	DB 인스턴스 내 접근 제어 규칙 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
hbaRules	Body	Array	접근 제어 규칙 목록
hbaRules.hbaRuleId	Body	UUID	접근 제어 규칙의 식별자
hbaRules.hbaRuleStatus	Body	Enum	접근 제어 규칙의 현재 상태 - `CREATED`: 생성됨 - `APPLIED`: 적용됨 - `CREATING`: 생성 중 - `MODIFYING`: 수정 중 - `DELETING`: 삭제 중 - `DELETED`: 삭제됨
hbaRules.databaseApplyType	Body	String	데이터베이스 규칙 적용 방식 - `ENTIRE`: 전체 - `USER_CUSTOM`: 사용자 지정
hbaRules.dbUserApplyType	Body	Enum	DB 사용자 규칙 적용 방식 - `ENTIRE`: 전체 - `USER_CUSTOM`: 사용자 지정
hbaRules.databases	Body	Array	사용자 지정 데이터베이스 목록
hbaRules.databases.databaseId	Body	UUID	사용자 지정 데이터베이스의 식별자
hbaRules.databases.databaseName	Body	String	사용자 지정 데이터베이스 이름
hbaRules.dbUsers	Body	Array	사용자 지정 DB 사용자 목록
hbaRules.dbUsers.dbUserId	Body	UUID	사용자 지정 DB 사용자의 식별자
hbaRules.dbUsers.dbUserName	Body	String	사용자 지정 DB 사용자 계정 이름
hbaRules.address	Body	String	접속 주소
hbaRules.authMethod	Body	Enum	인증 방식 - `TRUST`: 트러스트(패스워드 불필요) - `REJECT`: 접속 차단 - `SCRAM_SHA_256`: 패스워드(SCRAM-SHA-256)
hbaRules.reservedAction	Body	Enum	예악 작업 - `NONE`: 없음 - `CREATE`: 생성 예약(적용 필요) - `MODIFY`: 수정 예약(적용 필요) - `DELETE`: 삭제 예약(적용 필요)
hbaRules.order	Body	Number	적용 순서
hbaRules.applicable	Body	Boolean	적용 가능 여부 - 적용 불가 상태의 규칙은 무시됨
needToApply	Body	Boolean	변경 사항 적용 필요 여부

예시

{
    "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

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceHba.Create	DB 인스턴스 내 접근 제어 규칙 추가하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
databaseApplyType	Body	String	O	데이터베이스 규칙 적용 방식 - `ENTIRE`: 전체 - `USER_CUSTOM`: 사용자 지정
dbUserApplyType	Body	Enum	O	DB 사용자 규칙 적용 방식 - `ENTIRE`: 전체 - `USER_CUSTOM`: 사용자 지정
databaseIds	Body	Array	X	사용자 지정 데이터베이스의 식별자 목록
dbUserIds	Body	Array	X	사용자 지정 DB 사용자의 식별자 목록
address	Body	String	O	접속 주소 - CIDR 형식, 호스트명 또는 도메인 형식으로 입력
authMethod	Body	Enum	O	인증 방식 - `TRUST`: 트러스트(패스워드 불필요) - `REJECT`: 접속 차단 - `SCRAM_SHA_256`: 패스워드(SCRAM-SHA-256)

예시

{
    "databaseApplyType": "ENTIRE",
    "dbUserApplyType": "USER_CUSTOM",
    "databaseIds": [], 
    "dbUserIds": [
        "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4"
    ],
    "address": "0.0.0.0/0",
    "authMethod": "TRUST"
}

응답

이름	종류	형식	설명
hbaRuleId	Body	UUID	접근 제어 규칙의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "hbaRuleId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

접근 제어 규칙 수정하기

PUT /v1.0/db-instances/{dbInstanceId}/hba-rules/{hbaRuleId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceHba.Modify	DB 인스턴스 내 접근 제어 규칙 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
hbaRuleId	URL	UUID	O	접근 제어 규칙의 식별자
databaseApplyType	Body	String	O	데이터베이스 규칙 적용 방식 - `ENTIRE`: 전체 - `USER_CUSTOM`: 사용자 지정
dbUserApplyType	Body	Enum	O	DB 사용자 규칙 적용 방식 - `ENTIRE`: 전체 - `USER_CUSTOM`: 사용자 지정
databaseIds	Body	Array	X	사용자 지정 데이터베이스의 식별자 목록
dbUserIds	Body	Array	X	사용자 지정 DB 사용자의 식별자 목록
address	Body	String	O	접속 주소 - CIDR 형식, 호스트명 또는 도메인 형식으로 입력
authMethod	Body	Enum	O	인증 방식 - `TRUST`: 트러스트(패스워드 불필요) - `REJECT`: 접속 차단 - `SCRAM_SHA_256`: 패스워드(SCRAM-SHA-256)

예시

{
    "databaseApplyType": "ENTIRE",
    "dbUserApplyType": "ENTIRE",
    "databaseIds": [], 
    "dbUserIds": [],
    "address": "0.0.0.0/0",
    "authMethod": "REJECT"
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

접근 제어 규칙 삭제하기

DELETE /v1.0/db-instances/{dbInstanceId}/hba-rules/{hbaRuleId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceHba.Delete	DB 인스턴스 내 접근 제어 규칙 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
hbaRuleId	URL	UUID	O	접근 제어 규칙의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

접근 제어 규칙 순서 조정

PUT /v1.0/db-instances/{dbInstanceId}/hba-rules/orders

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstanceHba.Modify	DB 인스턴스 내 접근 제어 규칙 수정하기

요청

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자
hbaRuleIds	URL	Body	O	접근 제어 규칙의 식별자 목록 - 요청한 순서대로 조정됨

예시

{
    "hbaRuleIds": [
        "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4"
    ]
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

접근제어 규칙 적용하기

POST /v1.0/db-instances/{dbInstanceId}/hba-rules/apply

필요 권한

권한명	설명
RDSforPostgreSQL:DbInstance.Modify	DB 인스턴스 수정하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbInstanceId	URL	UUID	O	DB 인스턴스의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

백업

백업 목록 조회

GET /v1.0/backups

필요 권한

권한명	설명
RDSforPostgreSQL:Backup.List	백업 목록 조회

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
page	Query	Number	O	조회할 목록의 페이지 - 최솟값: `1`
size	Query	Number	O	조회할 목록의 페이지 크기 - 최솟값: `1` - 최댓값: `100`
backupType	Query	Enum	X	백업 유형 - `AUTO`: 자동 - `MANUAL`: 수동 - 기본값: `전체`
dbInstanceId	Query	UUID	X	원본 DB 인스턴스의 식별자
dbVersion	Query	Enum	X	DB 버전 정보

응답

이름	종류	형식	설명
totalCounts	Body	Number	전체 백업 목록 수
backups	Body	Array	백업 목록
backups.backupId	Body	UUID	백업의 식별자
backups.backupName	Body	String	백업을 식별할 수 있는 이름
backups.backupStatus	Body	Enum	백업의 현재 상태 - `BACKING_UP`: 백업 중인 경우 - `COMPLETED`: 백업이 완료된 경우 - `DELETING`: 백업이 삭제 중인 경우 - `DELETED`: 백업이 삭제된 경우 - `ERROR`: 오류가 발생한 경우
backups.dbInstanceId	Body	UUID	원본 DB 인스턴스의 식별자
backups.dbVersion	Body	Enum	DB 버전 정보
backups.backupType	Body	Enum	백업 유형 - `AUTO`: 자동 - `MANUAL`: 수동
backups.backupSize	Body	Number	백업의 크기 - 단위: `바이트`
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
completedYmdt	Body	DateTime	완료 일시(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"
        }
    ]
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

오브젝트 스토리지로 백업 내보내기

POST /v1.0/backups/{backupId}/export

필요 권한

권한명	설명
RDSforPostgreSQL:Backup.Export	오브젝트 스토리지로 백업 내보내기

요청

이름	종류	형식	필수	설명
backupId	URL	UUID	O	백업의 식별자
tenantId	Body	String	O	백업이 저장될 오브젝트 스토리지의 테넌트 ID
username	Body	String	O	NHN Cloud 계정 또는 IAM 계정 ID
password	Body	String	O	백업이 저장될 오브젝트 스토리지의 API 비밀번호
targetContainer	Body	String	O	백업이 저장될 오브젝트 스토리지의 컨테이너
objectPath	Body	String	O	컨테이너에 저장될 백업의 경로

예시

{
    "tenantId": "399631c404744dbbb18ce4fa2dc71a5a",
    "username": "gildong.hong@nhn.com",
    "password": "password",
    "targetContainer": "/container",
    "objectPath": "/backups/backup_file"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

백업 복원하기

POST /v1.0/backups/{backupId}/restore

필요 권한

권한명	설명
RDSforPostgreSQL:Backup.Restore	백업 복원하기

요청

이름	종류	형식	필수	설명
backupId	URL	UUID	O	백업의 식별자
dbInstanceName	Body	String	O	DB 인스턴스를 식별할 수 있는 이름
description	Body	String	X	DB 인스턴스에 대한 추가 정보
dbFlavorId	Body	UUID	O	DB 인스턴스 사양의 식별자
dbPort	Body	Number	O	DB 포트 - 최솟값: `5432` - 최댓값: `45432`
parameterGroupId	Body	UUID	O	파라미터 그룹의 식별자
dbSecurityGroupIds	Body	Array	X	DB 보안 그룹의 식별자 목록
userGroupIds	Body	Array	X	사용자 그룹의 식별자 목록
useDefaultNotification	Body	Boolean	X	기본 알림 사용 여부 - 기본값: `false`
useDeletionProtection	Body	Boolean	X	삭제 보호 여부 - 기본값: `false`
useHighAvailability	Body	Boolean	X	고가용성 사용 여부
pingInterval	Body	Number	X	고가용성 사용 시 Ping 간격(초) - 최솟값: `1` - 최댓값: `600`
failoverReplWaitingTime	Body	Number	X	고가용성 사용 시 장애 조치 대기 시간 - 최솟값: `-1` - -1로 설정 시, 복제 지연 해소까지 계속해서 대기합니다.
network	Body	Object	O	네트워크 정보 객체
network.subnetId	Body	UUID	O	서브넷의 식별자
network.usePublicAccess	Body	Boolean	X	외부 접속 가능 여부 - 기본값: `false`
network.availabilityZone	Body	Enum	X	DB 인스턴스를 생성할 가용성 영역 - 예시: `kr-pub-a` - 기본값: `임의의 가용성 영역`
storage	Body	Object	O	스토리지 정보 객체
storage.storageType	Body	Enum	O	데이터 스토리지 유형 - 예시: `General SSD`
storage.storageSize	Body	Number	O	데이터 스토리지 크기 - 단위: `기가바이트` - 최솟값: `20` - 최댓값: `2048`
backup	Body	Object	O	백업 정보 객체
backup.backupPeriod	Body	Number	O	백업 보관 기간(일) - 최솟값: `0` - 최댓값: `730`
backup.backupRetryCount	Body	Number	X	백업 재시도 횟수 - 기본값: `0` - 최솟값: `0` - 최댓값: `10`
backup.backupSchedules	Body	Array	X	백업 스케줄 목록
backup.backupSchedules.backupWndBgnTime	Body	String	O	백업 시작 시간 - 예시: `00:00:00`
backup.backupSchedules.backupWndDuration	Body	Enum	O	백업 Duration 백업 시작 시간부터 설정된 기간 안에 자동 백업이 실행됩니다. - `HALF_AN_HOUR`: 30분 - `ONE_HOUR`: 1시간 - `ONE_HOUR_AND_HALF`: 1시간 30분 - `TWO_HOURS`: 2시간 - `TWO_HOURS_AND_HALF`: 2시간 30분 - `THREE_HOURS`: 3시간

예시


{
  "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"
      }
    ]
  }
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

백업 삭제하기

DELETE /v1.0/backups/{backupId}

필요 권한

권한명	설명
RDSforPostgreSQL:Backup.Delete	백업 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
backupId	URL	UUID	O	백업의 식별자

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 보안 그룹

DB 보안 그룹 목록 보기

GET /v1.0/db-security-groups

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroup.List	DB 보안 그룹 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
dbSecurityGroups	Body	Array	DB 보안 그룹 목록
dbSecurityGroups.dbSecurityGroupId	Body	UUID	DB 보안 그룹의 식별자
dbSecurityGroups.dbSecurityGroupName	Body	String	DB 보안 그룹을 식별할 수 있는 이름
dbSecurityGroups.dbSecurityGroupStatus	Body	Enum	DB 보안 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
dbSecurityGroups.description	Body	String	DB 보안 그룹에 대한 추가 정보
dbSecurityGroups.progressStatus	Body	Enum	DB 보안 그룹의 현재 진행 상태 - `NONE`: 진행 중인 작업이 없음 - `CREATING_RULE`: 규칙 정책 생성 중 - `UPDATING_RULE`: 규칙 정책 수정 중 - `DELETING_RULE`: 규칙 정책 삭제 중 - `APPLYING_DEFAULT_RULE`: 기본 규칙 적용 중
dbSecurityGroups.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbSecurityGroups.updatedYmdt	Body	DateTime	수정 일시(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"
        }
    ]
}

DB 보안 그룹 상세 보기

GET /v1.0/db-security-groups/{dbSecurityGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroup.Get	DB 보안 그룹 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbSecurityGroupId	URL	UUID	O	DB 보안 그룹의 식별자

응답

이름	종류	형식	설명
dbSecurityGroupId	Body	UUID	DB 보안 그룹의 식별자
dbSecurityGroupName	Body	String	DB 보안 그룹을 식별할 수 있는 이름
dbSecurityGroupStatus	Body	Enum	DB 보안 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
description	Body	String	DB 보안 그룹에 대한 추가 정보
progressStatus	Body	Enum	DB 보안 그룹의 현재 진행 상태 - `NONE`: 진행 중인 작업이 없음 - `CREATING_RULE`: 규칙 정책 생성 중 - `UPDATING_RULE`: 규칙 정책 수정 중 - `DELETING_RULE`: 규칙 정책 삭제 중 - `APPLYING_DEFAULT_RULE`: 기본 규칙 적용 중
rules	Body	Array	DB 보안 그룹 규칙 목록
rules.ruleId	Body	UUID	DB 보안 그룹 규칙의 식별자
rules.description	Body	String	DB 보안 그룹 규칙에 대한 추가 정보
rules.direction	Body	Enum	통신 방향 - `INGRESS`: 수신 - `EGRESS`: 송신
rules.etherType	Body	Enum	Ether 유형 - `IPV4`: IPv4 - `IPV6`: IPv6
rules.port	Body	Object	포트 객체
rules.port.portType	Body	Enum	포트 유형 - `DB_PORT`: 각 DB 인스턴스 포트값으로 설정됩니다. - `PORT`: 지정된 포트값으로 설정됩니다. - `PORT_RANGE`: 지정된 포트 범위로 설정됩니다.
rules.port.minPort	Body	Number	최소 포트 범위
rules.port.maxPort	Body	Number	최대 포트 범위
rules.cidr	Body	String	허용할 트래픽의 원격 소스
rules.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
rules.updatedYmdt	Body	DateTime	수정 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(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"
    }
}

DB 보안 그룹 생성하기

POST /v1.0/db-security-groups

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroup.Create	DB 보안 그룹 생성하기

요청

이름	종류	형식	필수	설명
dbSecurityGroupName	Body	String	O	DB 보안 그룹을 식별할 수 있는 이름
description	Body	String	X	DB 보안 그룹에 대한 추가 정보
rules	Body	Array	O	DB 보안 그룹 규칙 목록
rules.description	Body	String	X	DB 보안 그룹 규칙에 대한 추가 정보
rules.direction	Body	Enum	O	통신 방향 - `INGRESS`: 수신 - `EGRESS`: 송신
rules.etherType	Body	Enum	O	Ether 유형 - `IPV4`: IPv4 - `IPV6`: IPv6
rules.cidr	Body	String	O	허용할 트래픽의 원격 소스 - 예시: `1.1.1.1/32`
rules.port	Body	Object	O	포트 객체
rules.port.portType	Body	Enum	O	포트 유형 - `DB_PORT`: 각 DB 인스턴스 포트값으로 설정됩니다. `minPort`값과 `maxPort`값을 필요로 하지 않습니다. - `PORT`: 지정된 포트값으로 설정됩니다. `minPort`값과 `maxPort`값이 같아야 합니다. - `PORT_RANGE`: 지정된 포트 범위로 설정됩니다.
rules.port.minPort	Body	Number	X	최소 포트 범위 - 수신 최솟값: 5432 - 송신 최솟값: 1
rules.port.maxPort	Body	Number	X	최대 포트 범위 - 수신 최댓값: 45432 - 송신 최댓값: 65535

예시

{
    "dbSecurityGroupName": "dbSecurityGroup",
    "description": "description",
    "rules": [
        {
            "direction": "INGRESS",
            "etherType": "IPV4",
            "port": {
                "portType": "PORT_RANGE",
                "minPort": 10000,
                "maxPort": 10005
            },
            "cidr": "0.0.0.0/0"
        }
    ]
}

응답

이름	종류	형식	설명
dbSecurityGroupId	Body	UUID	DB 보안 그룹의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708"
}

DB 보안 그룹 수정하기

PUT /v1.0/db-security-groups/{dbSecurityGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroup.Modify	DB 보안 그룹 수정하기

요청

이름	종류	형식	필수	설명
dbSecurityGroupId	URL	UUID	O	DB 보안 그룹의 식별자
dbSecurityGroupName	Body	String	X	DB 보안 그룹을 식별할 수 있는 이름
description	Body	String	X	DB 보안 그룹에 대한 추가 정보

예시

{
    "dbSecurityGroupName": "dbSecurityGroup",
    "description": "description"
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

DB 보안 그룹 삭제하기

DELETE /v1.0/db-security-groups/{dbSecurityGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroup.Delete	DB 보안 그룹 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbSecurityGroupId	URL	UUID	O	DB 보안 그룹의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

DB 보안 그룹 규칙 생성하기

POST /v1.0/db-security-groups/{dbSecurityGroupId}/rules

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroupRule.Create	DB 보안 그룹 규칙 생성하기

요청

이름	종류	형식	필수	설명
dbSecurityGroupId	URL	UUID	O	DB 보안 그룹의 식별자
description	Body	String	X	DB 보안 그룹 규칙에 대한 추가 정보
direction	Body	Enum	O	통신 방향 - `INGRESS`: 수신 - `EGRESS`: 송신
etherType	Body	Enum	O	Ether 유형 - `IPV4`: IPv4 - `IPV6`: IPv6
port	Body	Object	O	포트 객체
port.portType	Body	Enum	O	포트 유형 - `DB_PORT`: 각 DB 인스턴스 포트값으로 설정됩니다. `minPort`값과 `maxPort`값을 필요로 하지 않습니다. - `PORT`: 지정된 포트값으로 설정됩니다. `minPort`값과 `maxPort`값이 같아야 합니다. - `PORT_RANGE`: 지정된 포트 범위로 설정됩니다.
port.minPort	Body	Number	X	최소 포트 범위 - 수신 최솟값: 5432 - 송신 최솟값: 1
port.maxPort	Body	Number	X	최대 포트 범위 - 수신 최댓값: 45432 - 송신 최댓값: 65535
cidr	Body	String	O	허용할 트래픽의 원격 소스 - 예시: `1.1.1.1/32`

예시

{
    "direction": "INGRESS",
    "etherType": "IPV4",
    "port": {
        "portType": "PORT",
        "minPort": 10000,
        "maxPort": 10000
    },
    "cidr": "0.0.0.0/0"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 보안 그룹 규칙 수정하기

PUT /v1.0/db-security-groups/{dbSecurityGroupId}/rules/{ruleId}

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroupRule.Modify	DB 보안 그룹 규칙 수정하기

요청

이름	종류	형식	필수	설명
dbSecurityGroupId	URL	UUID	O	DB 보안 그룹의 식별자
ruleId	URL	UUID	O	DB 보안 그룹 규칙의 식별자
description	Body	String	X	DB 보안 그룹 규칙에 대한 추가 정보
direction	Body	Enum	O	통신 방향 - `INGRESS`: 수신 - `EGRESS`: 송신
etherType	Body	Enum	O	Ether 유형 - `IPV4`: IPv4 - `IPV6`: IPv6
port	Body	Object	O	포트 객체
port.portType	Body	Enum	O	포트 유형 - `DB_PORT`: 각 DB 인스턴스 포트값으로 설정됩니다. `minPort`값과 `maxPort`값을 필요로 하지 않습니다. - `PORT`: 지정된 포트값으로 설정됩니다. `minPort`값과 `maxPort`값이 같아야 합니다. - `PORT_RANGE`: 지정된 포트 범위로 설정됩니다.
port.minPort	Body	Number	X	최소 포트 범위 - 수신 최솟값: 5432 - 송신 최솟값: 1
port.maxPort	Body	Number	X	최대 포트 범위 - 수신 최댓값: 45432 - 송신 최댓값: 65535
cidr	Body	String	O	허용할 트래픽의 원격 소스 - 예시: `1.1.1.1/32`

예시

{
    "direction": "INGRESS",
    "etherType": "IPV4",
    "port": {
        "portType": "DB_PORT"
    },
    "cidr": "0.0.0.0/0"
}

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DB 보안 그룹 규칙 삭제하기

DELETE /v1.0/db-security-groups/{dbSecurityGroupId}/rules

필요 권한

권한명	설명
RDSforPostgreSQL:DbSecurityGroupRule.Create	DB 보안 그룹 규칙 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbSecurityGroupId	URL	UUID	O	DB 보안 그룹의 식별자
ruleIds	Query	Array	O	DB 보안 그룹 규칙의 식별자 목록

응답

이름	종류	형식	설명
jobId	Body	UUID	요청한 작업의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

파라미터 그룹

파라미터 그룹 목록 보기

GET /v1.0/parameter-groups

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.List	파라미터 그룹 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
dbVersion	Query	Enum	X	DB 버전 정보

응답

이름	종류	형식	설명
parameterGroups	Body	Array	파라미터 그룹 목록
parameterGroups.parameterGroupId	Body	UUID	파라미터 그룹의 식별자
parameterGroups.parameterGroupName	Body	String	파라미터 그룹을 식별할 수 있는 이름
parameterGroups.parameterGroupStatus	Body	Enum	파라미터 그룹의 현재 상태 - `STABLE`: 적용 완료 - `NEED_TO_APPLY`: 적용 필요
parameterGroups.description	Body	String	파라미터 그룹에 대한 추가 정보
parameterGroups.dbVersion	Body	Enum	DB 버전 정보
parameterGroups.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
parameterGroups.updatedYmdt	Body	DateTime	수정 일시(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}

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Get	파라미터 그룹 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
parameterGroupId	URL	UUID	O	파라미터 그룹의 식별자

응답

이름	종류	형식	설명
parameterGroupId	Body	UUID	파라미터 그룹의 식별자
parameterGroupName	Body	String	파라미터 그룹을 식별할 수 있는 이름
description	Body	String	파라미터 그룹에 대한 추가 정보
dbVersion	Body	Enum	DB 버전 정보
parameterGroupStatus	Body	Enum	파라미터 그룹의 현재 상태 - `STABLE`: 적용 완료 - `NEED_TO_APPLY`: 적용 필요 - `DELETED`: 삭제됨
parameters	Body	Array	파라미터 목록
parameters.parameterCategory	Body	String	파라미터 카테고리
parameters.parameterName	Body	String	파라미터 이름
parameters.value	Body	String	현재 설정된 값
parameters.valueUnit	Body	Enum	현재 설정된 값의 단위 - `B`: 바이트 - `kB`: 킬로바이트 - `MB`: 메가바이트 - `GB`: 기가바이트 - `TB`: 테라바이트 - `us`: 마이크로초 - `ms`: 밀리초 - `s`: 초 - `min`: 분 - `h`: 시 - `d`: 일
parameters.defaultValue	Body	String	기본값
parameters.allowedValue	Body	String	허용된 값
parameters.valueType	Body	Enum	값 유형 - `BOOLEAN`: 불린 유형 - `STRING`: 문자열 유형 - `NUMERIC`: 정수 및 부동 소수점 유형 - `NUMERIC_WITH_BYTE_UNIT`: 바이트 단위의 숫자 유형(예: 120KB, 100MB) - `NUMERIC_WITH_TIME_UNIT`: 시간 단위의 숫자 유형(예: 120ms, 100s, 1d) - `ENUMERATED`: 허용된 값에 선언된 값 중 한 개 입력 - `MULTI_ENUMERATED`: 허용된 값에 선언된 값 중 여러 개 입력(콤마(,)로 구분됨) - `TIMEZONE`: 타임존 유형
parameters.updateType	Body	Enum	수정 유형 - `VARIABLE`: 언제든 수정 가능 - `CONSTANT`: 수정 불가능
parameters.applyType	Body	Enum	적용 유형 - `SESSION`: 세션 적용 - `FILE`: 설정 파일 적용(재시작 필요) - `BOTH`: 전체
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
expressionAvailable	Body	Boolean	수식 허용 여부

예시

{
    "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

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Create	파라미터 그룹 생성하기

요청

이름	종류	형식	필수	설명
parameterGroupName	Body	String	O	파라미터 그룹을 식별할 수 있는 이름
description	Body	String	X	파라미터 그룹에 대한 추가 정보
dbVersion	Body	Enum	O	DB 버전 정보

예시

{
    "parameterGroupName": "parameter-group",
    "description": "description",
    "dbVersion": "POSTGRESQL_V146"
}

응답

이름	종류	형식	설명
parameterGroupId	Body	UUID	파라미터 그룹의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7"
}

파라미터 그룹 복사하기

POST /v1.0/parameter-groups/{parameterGroupId}/copy

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Copy	파라미터 그룹 복사하기

요청

이름	종류	형식	필수	설명
parameterGroupId	URL	UUID	O	파라미터 그룹의 식별자
parameterGroupName	Body	String	O	파라미터 그룹을 식별할 수 있는 이름
description	Body	String	X	파라미터 그룹에 대한 추가 정보

예시

{
    "parameterGroupName": "parameter-group-copy",
    "description": "copy"
}

응답

이름	종류	형식	설명
parameterGroupId	Body	UUID	파라미터 그룹의 식별자

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7"
}

파라미터 그룹 수정하기

PUT /v1.0/parameter-groups/{parameterGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Modify	파라미터 그룹 수정하기

요청

이름	종류	형식	필수	설명
parameterGroupId	URL	UUID	O	파라미터 그룹의 식별자
parameterGroupName	Body	String	X	파라미터 그룹을 식별할 수 있는 이름
description	Body	String	X	파라미터 그룹에 대한 추가 정보

예시

{
    "parameterGroupName": "parameter-group",
    "description": "description"
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

파라미터 수정하기

PUT /v1.0/parameter-groups/{parameterGroupId}/parameters

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Modify	파라미터 그룹 수정하기

요청

이름	종류	형식	필수	설명
parameterGroupId	URL	UUID	O	파라미터 그룹의 식별자
modifiedParameters	Body	Array	O	변경할 파라미터 목록
modifiedParameters.parameterName	Body	UUID	O	파라미터 이름
modifiedParameters.value	Body	String	O	변경할 파라미터 값

예시

{
   "modifiedParameters": [
       {
           "parameterName": "checkpoint_timeout",
           "value": "100s"
       }
   ]
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

파라미터 그룹 재설정하기

PUT /v1.0/parameter-groups/{parameterGroupId}/reset

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Reset	파라미터 그룹 재설정하기

요청

이름	종류	형식	필수	설명
parameterGroupId	URL	UUID	O	파라미터 그룹의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

파라미터 그룹 삭제하기

DELETE /v1.0/parameter-groups/{parameterGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:ParameterGroup.Delete	파라미터 그룹 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
parameterGroupId	URL	UUID	O	파라미터 그룹의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

사용자 그룹

사용자 그룹 목록 보기

GET /v1.0/user-groups

필요 권한

권한명	설명
RDSforPostgreSQL:UserGroup.List	사용자 그룹 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
userGroups	Body	Array	사용자 그룹 목록
userGroups.userGroupId	Body	UUID	사용자 그룹의 식별자
userGroups.userGroupName	Body	String	사용자 그룹을 식별할 수 있는 이름
userGroupStatus	Body	Enum	사용자 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
userGroups.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
userGroups.updatedYmdt	Body	DateTime	수정 일시(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}

필요 권한

권한명	설명
RDSforPostgreSQL:UserGroup.Get	사용자 그룹 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
userGroupId	URL	UUID	O	사용자 그룹의 식별자

응답

이름	종류	형식	설명
userGroupId	Body	UUID	사용자 그룹의 식별자
userGroupName	Body	String	사용자 그룹을 식별할 수 있는 이름
userGroupTypeCode	Body	Enum	사용자 그룹 종류 `ENTIRE`: 프로젝트 멤버 전체를 포함하는 사용자 그룹 `INDIVIDUAL_MEMBER`: 특정 프로젝트 멤버를 포함하는 사용자 그룹
userGroupStatus	Body	Enum	사용자 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
members	Body	Array	프로젝트 멤버 목록
members.memberId	Body	UUID	프로젝트 멤버의 식별자
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(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

필요 권한

권한명	설명
RDSforPostgreSQL:UserGroup.Create	사용자 그룹 생성하기

요청

이름	종류	형식	필수	설명
userGroupName	Body	String	O	사용자 그룹을 식별할 수 있는 이름
memberIds	Body	Array	O	프로젝트 멤버의 식별자 목록 `selectAllYN`이 true인 경우 해당 필드 값은 무시됨
selectAllYN	Body	Boolean	X	프로젝트 멤버 전체 유무 true인 경우 해당 그룹은 전체 멤버에 대해 설정됨

예시

{
    "userGroupName": "dev-team",
    "memberIds": ["1321e759-2ef3-4b85-9921-b13e918b24b5"]
}

{
    "userGroupName": "dev-team",
    "selectAllYN":true
}

응답

이름	종류	형식	설명
userGroupId	Body	UUID	사용자 그룹의 식별자

사용자 그룹 수정하기

PUT /v1.0/user-groups/{userGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:UserGroup.Modify	사용자 그룹 수정하기

요청

이름	종류	형식	필수	설명
userGroupId	URL	UUID	O	사용자 그룹의 식별자
userGroupName	Body	String	X	사용자 그룹을 식별할 수 있는 이름
memberIds	Body	Array	X	프로젝트 멤버의 식별자 목록
selectAllYN	Body	Boolean	X	프로젝트 멤버 전체 유무 true인 경우 해당 그룹은 전체 멤버에 대해 설정됨

예시

{
    "userGroupName": "dev-team",
    "memberIds": ["1321e759-2ef3-4b85-9921-b13e918b24b5","f9064b09-2b15-442e-a4b0-3a5a2754555e"]
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

사용자 그룹 삭제하기

DELETE /v1.0/user-groups/{userGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:UserGroup.Delete	사용자 그룹 삭제하기

요청

이름	종류	형식	필수	설명
userGroupId	URL	UUID	O	사용자 그룹의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

알림 그룹

알림 그룹 목록 보기

GET /v1.0/notification-groups

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationGroup.List	알림 그룹 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
notificationGroups	Body	Array	알림 그룹 목록
notificationGroups.notificationGroupId	Body	UUID	알림 그룹의 식별자
notificationGroups.notificationGroupName	Body	String	알림 그룹을 식별할 수 있는 이름
notificationGroups.notificationGroupStatus	Body	Enum	알림 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
notificationGroups.notifyEmail	Body	Boolean	이메일 알림 여부
notificationGroups.notifySms	Body	Boolean	SMS 알림 여부
notificationGroups.isEnabled	Body	Boolean	활성화 여부
notificationGroups.createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
notificationGroups.updatedYmdt	Body	DateTime	수정 일시(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}

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationGroup.Get	알림 그룹 상세 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
notificationGroupId	URL	UUID	O	알림 그룹의 식별자

응답

이름	종류	형식	설명
notificationGroupId	Body	UUID	알림 그룹의 식별자
notificationGroupName	Body	String	알림 그룹을 식별할 수 있는 이름
notificationGroupStatus	Body	Enum	알림 그룹의 현재 상태 - `CREATED`: 생성됨 - `DELETED`: 삭제됨
notifyEmail	Body	Boolean	이메일 알림 여부
notifySms	Body	Boolean	SMS 알림 여부
isEnabled	Body	Boolean	활성화 여부
dbInstances	Body	Array	감시 대상 DB 인스턴스 목록
dbInstances.dbInstanceId	Body	UUID	DB 인스턴스의 식별자
dbInstances.dbInstanceName	Body	String	DB 인스턴스를 식별할 수 있는 이름
userGroups	Body	Array	사용자 그룹 목록
userGroups.userGroupId	Body	UUID	사용자 그룹의 식별자
userGroups.userGroupName	Body	String	사용자 그룹을 식별할 수 있는 이름
createdYmdt	Body	DateTime	생성 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	수정 일시(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

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationGroup.Create	알림 그룹 생성하기

요청

이름	종류	형식	필수	설명
notificationGroupName	Body	String	O	알림 그룹을 식별할 수 있는 이름
notifyEmail	Body	Boolean	X	이메일 알림 여부 - 기본값: `true`
notifySms	Body	Boolean	X	SMS 알림 여부 - 기본값: `true`
isEnabled	Body	Boolean	X	활성화 여부 - 기본값: `true`
dbInstanceIds	Body	Array	X	감시 대상 DB 인스턴스의 식별자 목록
userGroupIds	Body	Array	X	사용자 그룹의 식별자 목록

예시

{
    "notificationGroupName": "dev-team-noti",
    "notifyEmail": false,
    "isEnable": true,
    "dbInstanceIds": ["ed5cb985-526f-4c54-9ae0-40288593de65"],
    "userGroupIds": ["1aac0437-f32d-4923-ad3c-ac61c1cfdfe0"]
}

응답

이름	종류	형식	설명
notificationGroupId	Body	UUID	알림 그룹의 식별자

알림 그룹 수정하기

PUT /v1.0/notification-groups/{notificationGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationGroup.Modify	알림 그룹 수정하기

요청

이름	종류	형식	필수	설명
notificationGroupId	URL	UUID	O	알림 그룹의 식별자
notificationGroupName	Body	String	X	알림 그룹을 식별할 수 있는 이름
notifyEmail	Body	Boolean	X	이메일 알림 여부
notifySms	Body	Boolean	X	SMS 알림 여부
isEnabled	Body	Boolean	X	활성화 여부
dbInstanceIds	Body	Array	X	감시 대상 DB 인스턴스의 식별자 목록
userGroupIds	Body	Array	X	사용자 그룹의 식별자 목록

예시

{
    "notifyEmail": true,
    "dbInstanceIds": ["ed5cb985-526f-4c54-9ae0-40288593de65", "d51b7da0-682f-47ff-b588-b739f6adc740"]
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

알림 그룹 삭제하기

DELETE /v1.0/notification-groups/{notificationGroupId}

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationGroup.Delete	알림 그룹 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
notificationGroupId	URL	UUID	O	알림 그룹의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

감시 설정 목록 보기

GET /v1.0/notification-groups/{notificationGroupId}/watchdogs

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationWatchdog.List	감시 설정 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
notificationGroupId	URL	UUID	알림 그룹의 식별자
watchdogs	Body	Array	감시 설정 목록
watchdogs.watchdogId	Body	UUID	감시 설정의 식별자
watchdogs.metricName	Body	Enum	감시 대상 성능 지표 - 설정 가능한 성능 지표는 성능 지표 목록 보기 항목을 참고합니다.
watchdogs.comparisonOperator	Body	Enum	감시 대상 비교 방법 - `LE`: <= - `LT`: < - `GE`: >= - `GT`: >
watchdogs.threshold	Body	Long	감시 대상 임곗값
watchdogs.duration	Body	Long	감시 대상 지속 시간 - 단위: `분`
watchdogs.createdYmdt	Body	DateTime	생성 일시(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

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationWatchdog.Create	감시 설정 생성하기

요청

이름	종류	형식	필수	설명
notificationGroupId	URL	UUID	O	알림 그룹의 식별자
metricName	Body	Enum	O	감시 대상 성능 지표 - 설정 가능한 성능 지표는 성능 지표 목록 보기 항목을 참고합니다.
comparisonOperator	Body	Enum	O	감시 대상 비교 방법 - `LE`: <= - `LT`: < - `GE`: >= - `GT`: >
threshold	Body	Long	O	감시 대상 임곗값
duration	Body	Long	O	감시 대상 지속 시간 - 단위: `분`

예시

{
    "metricName": "DATABASE_STATUS",
    "comparisonOperator": "LE",
    "threshold": 0,
    "duration": 5
}

응답

이름	종류	형식	설명
watchdogId	Body	UUID	감시 설정의 식별자

감시 설정 수정하기

PUT /v1.0/notification-groups/{notificationGroupId}/watchdogs/{watchdogId}

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationWatchdog.Modify	감시 설정 수정하기

요청

이름	종류	형식	필수	설명
notificationGroupId	URL	UUID	O	알림 그룹의 식별자
watchdogId	URL	UUID	O	감시 설정의 식별자
metricName	Body	Enum	O	감시 대상 성능 지표 - 설정 가능한 성능 지표는 성능 지표 목록 보기 항목을 참고합니다.
comparisonOperator	Body	Enum	O	감시 대상 비교 방법 - `LE`: <= - `LT`: < - `GE`: >= - `GT`: >
threshold	Body	Long	O	감시 대상 임곗값
duration	Body	Long	O	감시 대상 지속 시간 - 단위: `분`

예시

{
    "metricName": "DATABASE_STATUS",
    "comparisonOperator": "LE",
    "threshold": 0,
    "duration": 10
}

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

감시 설정 삭제하기

DELETE /v1.0/notification-groups/{notificationGroupId}/watchdogs/{watchdogId}

필요 권한

권한명	설명
RDSforPostgreSQL:NotificationWatchdog.Delete	감시 설정 삭제하기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
notificationGroupId	URL	UUID	O	알림 그룹의 식별자
watchdogId	URL	UUID	O	감시 설정의 식별자

응답

이 API는 응답 본문을 반환하지 않습니다.

예시

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

모니터링

성능 지표 목록 보기

GET /v1.0/metrics

필요 권한

권한명	설명
RDSforPostgreSQL:Metric.List	통계 정보 조회

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
metrics	Body	Array	성능 지표 목록
metrics.metricName	Body	Enum	성능 지표 유형
metrics.unit	Body	String	측정값 단위

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "metrics": [
        {
            "metricName": "CPU_USAGE",
            "unit": "%"
        }
    ]
}

통계 정보 조회

GET /v1.0/metric-statistics

필요 권한

권한명	설명
RDSforPostgreSQL:Metric.List	통계 정보 조회

요청

이름	종류	형식	필수	설명
dbInstanceId	Query	UUID	O	DB 인스턴스의 식별자
metricNames	Query	Array	O	조회할 성능 지표 목록 - 최소 크기: `1`
from	Query	Datetime	O	시작 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
to	Query	Datetime	O	종료 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
interval	Query	Number	X	조회 간격 - 단위: `분` - 기본값: 시작/종료 일시에 따라 적절한 값을 자동 선택함

응답

이름	종류	형식	설명
metricStatistics	Body	Array	통계 정보 목록
metricStatistics.metricName	Body	Enum	성능 지표 유형
metricStatistics.unit	Body	String	측정값 단위
metricStatistics.values	Body	Array	측정값 목록
metricStatistics.values.timestamp	Body	Timestamp	측정 시간
metricStatistics.values.value	Body	Object	측정값

예시

{
    "metricStatistics": [
        {
            "metricName": "DATABASE_STATUS",
            "unit": "",
            "values": [
                [
                    1679298540,
                    "1"
                ],
                [
                    1679298600,
                    "1"
                ],
                [
                    1679298660,
                    "1"
                ]
            ]
        }
    ]
}

이벤트

이벤트 목록 보기

GET /v1.0/events

필요 권한

권한명	설명
RDSforPostgreSQL:Event.List	이벤트 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

이름	종류	형식	필수	설명
page	Query	Number	O	조회할 목록의 페이지 - 최솟값: `1`
size	Query	Number	O	조회할 목록의 페이지 크기 - 최솟값: `1` - 최댓값: `100`
from	Query	Datetime	O	시작 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
to	Query	Datetime	O	종료 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)
eventCategoryType	Query	Enum	O	조회할 이벤트 카테고리 유형 - `ALL`: 전체 - `BACKUP`: 백업 - `DB_INSTANCE`: DB 인스턴스 - `DB_SECURITY_GROUP`: DB 보안 그룹 - `JOB`: 작업 - `TENANT`: 테넌트 - `MONITORING`: 모니터링
sourceId	Query	String	X	이벤트가 발생한 대상 리소스의 식별자
keyword	Query	String	X	이벤트 메시지에 포함된 문자열 검색어

응답

이름	종류	형식	설명
totalCounts	Body	Number	전체 이벤트 목록 수
events	Body	Array	이벤트 목록
events.eventCategoryType	Body	Enum	이벤트 카테고리 유형
events.eventCode	Body	Enum	발생한 이벤트의 유형 - 자세한 설명은 이벤트 항목을 참고합니다.
events.sourceId	Body	String	이벤트 소스의 식별자
events.sourceName	Body	String	이벤트 소스를 식별할 수 있는 이름
events.messages	Body	Array	이벤트 메시지 목록
events.messages.langCode	Body	String	언어 코드
events.messages.message	Body	String	이벤트 메시지
events.eventYmdt	Body	DateTime	이벤트 발생 일시(YYYY-MM-DDThh:mm:ss.SSSTZD)

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "totalCounts": 28,
    "events": [
        {
            "eventCategoryType": "DB_INSTANCE",
            "eventCode": "DB_INSTANCE_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

필요 권한

권한명	설명
RDSforPostgreSQL:Event.List	이벤트 목록 보기

요청

이 API는 요청 본문을 요구하지 않습니다.

응답

이름	종류	형식	설명
eventCodes	Body	Array	이벤트 코드 목록
eventCodes.eventCode	Body	Enum	이벤트 코드
eventCodes.eventCategoryType	Body	Enum	이벤트 카테고리 유형

예시

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "eventCodes": [
        {
            "eventCode": "DB_INSTANCE_02_01",
            "eventCategoryType": "DB_INSTANCE"
        }
    ]
}

Database > RDS for PostgreSQL > API 가이드
인증 및 권한
응답 공통 정보
응답 본문
필드
DB 버전
DB 버전 목록 보기
DB 인스턴스 사양
DB 인스턴스 사양 목록 보기
프로젝트 정보
리전 목록 보기
프로젝트 멤버 목록 보기
네트워크
서브넷 목록 보기
스토리지
스토리지 유형 목록 보기
작업 정보
작업 정보 상세 보기
DB 인스턴스 그룹
DB 인스턴스 그룹 목록 보기
DB 인스턴스 그룹 상세 보기
DB 인스턴스
DB 인스턴스 상태
DB 인스턴스 진행 상태
DB 인스턴스 목록 보기
DB 인스턴스 상세 보기
DB 인스턴스 생성하기
DB 인스턴스 수정하기
고가용성 정보 조회
고가용성 수정하기
고가용성 다시 시작하기
고가용성 일시 중지하기
고가용성 복구하기
고가용성 분리하기
DB 인스턴스 스토리지 정보 조회
DB 인스턴스 스토리지 정보 수정하기
DB 인스턴스 네트워크 정보 조회
DB 인스턴스 네트워크 정보 수정하기
DB 인스턴스 백업 정보 조회
DB 인스턴스 백업 정보 수정하기
DB 인스턴스 복원 정보 조회
DB 인스턴스 복원하기
DB 인스턴스 삭제 보호 설정 변경하기
DB 인스턴스 삭제하기
DB 인스턴스 재시작하기
DB 인스턴스 강제 재시작하기
DB 인스턴스 시작하기
DB 인스턴스 정지하기
DB 인스턴스 백업하기
DB 인스턴스 백업 후 내보내기
DB 인스턴스 최신 파라미터 그룹 적용하기
DB 인스턴스 복제하기
DB 인스턴스 승격하기
DB 인스턴스 > 데이터베이스
데이터베이스 목록 보기
데이터베이스 생성하기
데이터베이스 수정하기
데이터베이스 삭제하기
DB 인스턴스 > 사용자
사용자 목록 보기
사용자 생성하기
사용자 수정하기
사용자 삭제하기
DB 인스턴스 > 접근 제어
접근 제어 규칙 목록 보기
접근 제어 규칙 추가하기
접근 제어 규칙 수정하기
접근 제어 규칙 삭제하기
접근 제어 규칙 순서 조정
접근제어 규칙 적용하기
백업
백업 목록 조회
오브젝트 스토리지로 백업 내보내기
백업 복원하기
백업 삭제하기
DB 보안 그룹
DB 보안 그룹 목록 보기
DB 보안 그룹 상세 보기
DB 보안 그룹 생성하기
DB 보안 그룹 수정하기
DB 보안 그룹 삭제하기
DB 보안 그룹 규칙 생성하기
DB 보안 그룹 규칙 수정하기
DB 보안 그룹 규칙 삭제하기
파라미터 그룹
파라미터 그룹 목록 보기
파라미터 그룹 상세 보기
파라미터 그룹 생성하기
파라미터 그룹 복사하기
파라미터 그룹 수정하기
파라미터 수정하기
파라미터 그룹 재설정하기
파라미터 그룹 삭제하기
사용자 그룹
사용자 그룹 목록 보기
사용자 그룹 상세 보기
사용자 그룹 생성하기
사용자 그룹 수정하기
사용자 그룹 삭제하기
알림 그룹
알림 그룹 목록 보기
알림 그룹 상세 보기
알림 그룹 생성하기
알림 그룹 수정하기
알림 그룹 삭제하기
감시 설정 목록 보기
감시 설정 생성하기
감시 설정 수정하기
감시 설정 삭제하기
모니터링
성능 지표 목록 보기
통계 정보 조회
이벤트
이벤트 목록 보기
구독 가능한 이벤트 코드 목록 보기

TOP