createCloudPostgresqlInstance

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

VPC 환경에서 이용 가능합니다.

Cloud DB for PostgreSQL 인스턴스를 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET, POST	/createCloudPostgresqlInstance

요청 헤더

Cloud DB for PostgreSQL (VPC) API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for PostgreSQL (VPC) 요청 헤더를 참조해 주십시오.

요청 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	리전 코드 생성할 Cloud DB for PostgreSQL 인스턴스의 리전 코드 getRegionList를 통해 확인 `getRegionList` 조회 결과의 첫 번째 리전(기본값)
`vpcNo`	String	Required	Cloud DB for PostgreSQL 인스턴스를 생성할 VPC 번호 getCloudPostgresqlTargetVpcList를 통해 확인
`subnetNo`	String	Required	Cloud DB for PostgreSQL 인스턴스에서 사용할 기본 네트워크 인터페이스의 Subnet 번호 getCloudPostgresqlTargetSubnetList를 통해 확인 Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능 Cloud DB for PostgreSQL 인스턴스 생성 이후 Subnet 이전 불가
`secondarySubnetNo`	String	Conditional	Secondary 서버의 Subnet 번호 Multi Zone인 CloudDB for PostgreSQL인 경우 필수 입력 Primary 서버의 Subnet과 Zone이 다르고, Public 또는 Private는 같아야 함 getCloudPostgresqlTargetSubnetList를 통해 확인
`cloudPostgresqlImageProductCode`	String	Optional	Cloud DB for PostgreSQL 이미지 상품 코드 getCloudPostgresqlImageProductList를 통해 확인 네이버 클라우드 플랫폼에서 자동 생성(기본값)
`cloudPostgresqlProductCode`	String	Optional	Cloud DB for PostgreSQL 상품 코드 생성할 Cloud DB for PostgreSQL 인스턴스의 서버 스펙을 결정 getCloudPostgresqlProductList를 통해 확인 최소 사양(기본값) 최소 사양의 기준: 1. 메모리 2. CPU 순서로 결정
`dataStorageTypeCode`	String	Optional	데이터 스토리지 타입 코드 설치 이후 데이터 스토리지 타입 변경 불가 `SSD` (기본값) \| `HDD`
`isHa`	Boolean	Optional	고가용성 여부 `true` (기본값) \| `false` `true`(고가용성 선택)인 경우 Secondary 서버를 포함한 2대의 서버로 생성되며 추가 요금 발생 `false`인 경우 `isMultiZone`, `standbyMasterSubnetNo` 파라미터는 사용되지 않음
`isMultiZone`	Boolean	Conditional	Multi Zone 여부 `true` \| `false` (기본값) 고가용성 여부(`isHa`)가 `true`일 경우 필수 입력 `true`인 경우 Primary 서버와 Secondary 서버를 서로 다른 Zone에 생성하여 더욱 높은 가용성을 제공 Neurocloud 환경에서는 이용 불가
`isStorageEncryption`	Boolean	Optional	데이터 스토리지 암호화 적용 여부 (추후 적용) `true` \| `false` (기본값) 암호화 적용 시, DB 데이터는 암호화되어 스토리지에 저장 Cloud DB for PostgreSQL 인스턴스 생성 이후 스토리지 암호화 설정 변경 불가 Neurocloud 환경에서는 이용 불가
`isBackup`	Boolean	Optional	PostgreSQL의 백업 설정 여부 `true` (기본값) \| `false` 고가용성 여부(`isHa`)가 `true`일 경우 백업 여부(`isBackup`)는 `true`로 고정
`backupFileRetentionPeriod`	Integer	Optional	백업 파일 보관 기간(일) 1 (기본값) 백업은 매일 수행되며, 백업 파일은 별도의 스토리지에 저장 요금은 사용하는 공간만큼만 과금
`backupTime`	String	Conditional	백업 시점 설정 `true` (기본값) \| `false` 백업 여부(`isBackup`)가 `true`, 자동 백업 여부(`isAutomaticBackup`)가 `false`인 경우 필수 입력 <예시>01:15
`backupFileStorageCount`	Integer	Optional	백업 파일 보관 개수 1~30
`isBackupFileCompression`	Boolean	Optional	백업 파일 압축 여부 `true` (기본값) \| `false`
`isAutomaticBackup`	Boolean	Optional	백업 시점 자동 설정 여부 `true` (기본값) \| `false` 설정 값이 `true`인 경우, `backupTime` 입력 불가
`cloudPostgresqlServiceName`	String	Required	생성할 Cloud DB for PostgreSQL 서비스 이름 3~30자로 영문자, 숫자, 한글, 특수 문자 '-' 만 입력 가능
`cloudPostgresqlServerNamePrefix`	String	Required	생성할 Cloud DB for PostgreSQL 서버 이름 접두사 3~20자로 소문자, 숫자, 특수 문자 '-' 를 허용하며 영문자로 시작해서 영문자 또는 숫자로 끝나야 함 접두사 뒤에 3자리 숫자가 자동으로 만들어지고, 호스트명 중복 방지를 위해 임의의 텍스트가 추가로 포함되어 생성됨 <예시> 접두사가 test-123인 경우: `test-123-001-523a`
`cloudPostgresqlUserName`	String	Required	DB User 계정 아이디 4~16자로 소문자, 숫자, 특수 문자 '_'를 허용하며 영문자로 시작해야 함 미리 정의된 role 및 예약어 사용 불가
`cloudPostgresqlUserPassword`	String	Required	DB User 계정 패스워드 8~20자로 영문, 숫자, 특수문자를 각 1자 이상씩 포함하여 조합 특수문자 ` & + \ " ' / 및 공백 사용 불가 User ID 포함 불가
`clientCidr`	String	Required	접속하려는 클라이언트의 CIDR(접근 제어)를 입력 <예시> 전체 접속 허용: 0.0.0.0/0 특정 IP 접속 허용: 192.168.1.1/32 IP 대역 접속 허용: 192.168.1.0/24
`cloudPostgresqlPort`	Integer	Optional	Cloud DB for PostgreSQL 인스턴스에 접근하기 위한 TCP 포트 번호 5432 (기본값) 지정 범위: 10000~20000 한 번 지정한 포트 번호는 변경 불가
`cloudPostgresqlDatabaseName`	String	Required	Cloud DB for PostgreSQL 인스턴스에 기본으로 생성할 DB 이름 1~30자로 소문자, 숫자, 특수 문자 '_'를 허용하며 영문자로 시작해야 함
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/createCloudPostgresqlInstance
?regionCode=KR
&vpcNo=****87
&subnetNo=****49
&secondarySubnetNo=****51
&cloudPostgresqlImageProductCode=SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050
&cloudPostgresqlProductCode=SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002
&dataStorageTypeCode=SSD
&isHa=true
&isMultiZone=true
&isStorageEncryption=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.CNTOS.0708.PGSQL.133.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>

이 문서가 도움이 되었습니까?

What's Next

createCloudPostgresqlReadReplicaInstance

요청
응답

태그

Cloud DB for PostgreSQL