VPC 환경에서 이용 가능합니다.
Cloud DB for PostgreSQL 인스턴스를 생성합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET, POST | /createCloudPostgresqlInstance |
요청 헤더
Cloud DB for PostgreSQL (VPC) API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for PostgreSQL (VPC) 요청 헤더를 참조해 주십시오.
요청 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
regionCode |
String | Optional | 리전 코드
|
vpcNo |
String | Required | Cloud DB for PostgreSQL 인스턴스를 생성할 VPC 번호 |
subnetNo |
String | Required | Cloud DB for PostgreSQL 인스턴스에서 사용할 기본 네트워크 인터페이스의 Subnet 번호
|
cloudPostgresqlImageProductCode |
String | Optional | Cloud DB for PostgreSQL 이미지 상품 코드
|
cloudPostgresqlProductCode |
String | Optional | Cloud DB for PostgreSQL 상품 코드
|
dataStorageTypeCode |
String | Optional | 데이터 스토리지 타입 코드
|
isHa |
Boolean | Optional | 고가용성 여부
|
isBackup |
Boolean | Optional | PostgreSQL의 백업 설정 여부
|
backupFileRetentionPeriod |
Integer | Optional | 백업 파일 보관 기간(일)
|
backupTime |
String | Conditional | 백업 시점 설정
|
backupFileStorageCount |
Integer | Optional | 백업 파일 보관 개수
|
isBackupFileCompression |
Boolean | Optional | 백업 파일 압축 여부
|
isAutomaticBackup |
Boolean | Optional | 백업 시점 자동 설정 여부
|
cloudPostgresqlServiceName |
String | Required | 생성할 Cloud DB for PostgreSQL 서비스 이름
|
cloudPostgresqlServerNamePrefix |
String | Required | 생성할 Cloud DB for PostgreSQL 서버 이름 접두사
|
cloudPostgresqlUserName |
String | Required | DB User 계정 아이디
|
cloudPostgresqlUserPassword |
String | Required | DB User 계정 패스워드
|
clientCidr |
String | Required | 접속하려는 클라이언트의 CIDR(접근 제어)를 입력
|
cloudPostgresqlPort |
Integer | Optional | Cloud DB for PostgreSQL 인스턴스에 접근하기 위한 TCP 포트 번호
|
cloudPostgresqlDatabaseName |
String | Required | Cloud DB for PostgreSQL 인스턴스에 기본으로 생성할 DB 이름
|
engineVersionCode |
String | Optional | Cloud DB for PostgreSQL 인스턴스에 적용할 엔진 버전
|
responseFormatType |
String | Optional | 응답 결과의 형식
|
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vpostgresql/v2/createCloudPostgresqlInstance
?regionCode=KR
&vpcNo=****87
&subnetNo=****49
&cloudPostgresqlImageProductCode=SW.VPGSL.OS.LNX64.ROCKY.0810.PGSQL.B050
&cloudPostgresqlProductCode=SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002
&dataStorageTypeCode=SSD
&isHa=true
&isBackup=true
&backupFileRetentionPeriod=10
&backupFileStorageCount=5
&backupTime=02:00
&isBackupFileCompression=true
&isAutomaticBackup=false
&cloudPostgresqlServiceName=test-****
&cloudPostgresqlServerNamePrefix=test-****
&cloudPostgresqlUserName=test****
&cloudPostgresqlUserPassword=********
&clientCidr=0.0.0.0/0
&cloudPostgresqlPort=15432
&cloudPostgresqlDatabaseName=test****'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디는 CloudPostgresqlInstanceList를 참조해 주십시오.
응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
responseFormatType=json일 때
{
"createCloudPostgresqlInstanceResponse": {
"totalRows": 1,
"cloudPostgresqlInstanceList": [
{
"cloudPostgresqlInstanceNo": "****925",
"cloudPostgresqlServiceName": "test-****",
"cloudPostgresqlInstanceStatusName": "creating",
"cloudPostgresqlInstanceStatus": {
"code": "INIT",
"codeName": "CLOUD DATABASE(VPC) Init State"
},
"cloudPostgresqlInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Creat OP"
},
"cloudPostgresqlImageProductCode": "SW.VPGSL.OS.LNX64.ROCKY.0810.PGSQL.B050",
"engineVersion": "PostgreSQL 13.3",
"license": "PostgreSQL License",
"cloudPostgresqlPort": 15432,
"isHa": true,
"isMultiZone": true,
"isBackup": true,
"backupFileRetentionPeriod": 10,
"backupTime": "02:00",
"createDate": "2024-06-03T10:47:11+0900",
"accessControlGroupNoList": [],
"cloudPostgresqlConfigList": [
"sample_config=sample_value"
],
"cloudPostgresqlServerInstanceList": [
{
"cloudPostgresqlServerName": "test-****-001-523a",
"cloudPostgresqlServerRole": {
"code": "M",
"codeName": "Primary"
},
"cloudPostgresqlServerInstanceStatusName": "creating",
"cloudPostgresqlServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudPostgresqlServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****87",
"subnetNo": "****49",
"isPublicSubnet": true,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"isStorageEncryption": true,
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592,
"createDate": "2024-06-03T10:47:11+0900"
},
{
"cloudPostgresqlServerName": "test-****-002-523b",
"cloudPostgresqlServerRole": {
"code": "H",
"codeName": "Secondary"
},
"cloudPostgresqlServerInstanceStatusName": "creating",
"cloudPostgresqlServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudPostgresqlServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "****87",
"subnetNo": "****51",
"isPublicSubnet": true,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"isStorageEncryption": true,
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592,
"createDate": "2024-06-03T10:47:11+0900"
}
]
}
],
"requestId": "a3ab2112-****-****-****-e8deb543d4c2",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml(기본값) 일 때
<?xml version="1.0" encoding="UTF-8"?>
<createCloudPostgresqlInstanceResponse>
<requestId>a3ab2112-****-****-****-e8deb543d4c2</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<cloudPostgresqlInstanceList>
<cloudPostgresqlInstance>
<cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
<cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
<cloudPostgresqlInstanceStatusName>creating</cloudPostgresqlInstanceStatusName>
<cloudPostgresqlInstanceStatus>
<code>INIT</code>
<codeName>CLOUD DATABASE(VPC) Init State</codeName>
</cloudPostgresqlInstanceStatus>
<cloudPostgresqlInstanceOperation>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
</cloudPostgresqlInstanceOperation>
<cloudPostgresqlImageProductCode>SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050</cloudPostgresqlImageProductCode>
<engineVersion>PostgreSQL 13.3</engineVersion>
<license>PostgreSQL License</license>
<cloudPostgresqlPort>15432</cloudPostgresqlPort>
<isHa>true</isHa>
<isMultiZone>true</isMultiZone>
<isBackup>true</isBackup>
<backupFileRetentionPeriod>10</backupFileRetentionPeriod>
<backupTime>02:00</backupTime>
<createDate>2024-06-03T10:47:11+0900</createDate>
<accessControlGroupNoList/>
<cloudPostgresqlConfigList>
<cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
</cloudPostgresqlConfigList>
<cloudPostgresqlServerInstanceList>
<cloudPostgresqlServerInstance>
<cloudPostgresqlServerName>test-****-001-523a</cloudPostgresqlServerName>
<cloudPostgresqlServerRole>
<code>M</code>
<codeName>Primary</codeName>
</cloudPostgresqlServerRole>
<cloudPostgresqlServerInstanceStatusName>creating</cloudPostgresqlServerInstanceStatusName>
<cloudPostgresqlServerInstanceStatus>
<code>PEND</code>
<codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
</cloudPostgresqlServerInstanceStatus>
<cloudPostgresqlServerInstanceOperation>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
</cloudPostgresqlServerInstanceOperation>
<cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002</cloudPostgresqlProductCode>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****87</vpcNo>
<subnetNo>****49</subnetNo>
<isPublicSubnet>true</isPublicSubnet>
<dataStorageType>
<code>SSD</code>
<codeName>SSD</codeName>
</dataStorageType>
<isStorageEncryption>true</isStorageEncryption>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
<createDate>2024-06-03T10:47:11+0900</createDate>
</cloudPostgresqlServerInstance>
<cloudPostgresqlServerInstance>
<cloudPostgresqlServerName>test-****-002-523b</cloudPostgresqlServerName>
<cloudPostgresqlServerRole>
<code>H</code>
<codeName>Secondary</codeName>
</cloudPostgresqlServerRole>
<cloudPostgresqlServerInstanceStatusName>creating</cloudPostgresqlServerInstanceStatusName>
<cloudPostgresqlServerInstanceStatus>
<code>PEND</code>
<codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
</cloudPostgresqlServerInstanceStatus>
<cloudPostgresqlServerInstanceOperation>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
</cloudPostgresqlServerInstanceOperation>
<cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002</cloudPostgresqlProductCode>
<regionCode>KR</regionCode>
<zoneCode>KR-2</zoneCode>
<vpcNo>****87</vpcNo>
<subnetNo>****51</subnetNo>
<isPublicSubnet>true</isPublicSubnet>
<dataStorageType>
<code>SSD</code>
<codeName>SSD</codeName>
</dataStorageType>
<isStorageEncryption>true</isStorageEncryption>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
<createDate>2024-06-03T10:47:11+0900</createDate>
</cloudPostgresqlServerInstance>
</cloudPostgresqlServerInstanceList>
</cloudPostgresqlInstance>
</cloudPostgresqlInstanceList>
</createCloudPostgresqlInstanceResponse>