createCloudPostgresqlReadReplicaInstance
    • PDF

    createCloudPostgresqlReadReplicaInstance

    • PDF

    Article summary

    Available in VPC

    Create a read replica server instance to a Cloud DB for PostgreSQL instance.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    GET, POST/createCloudPostgresqlReadReplicaInstance

    Request headers

    For headers common to all Cloud DB for PostgreSQL (VPC) APIs, see Cloud DB for PostgreSQL (VPC) request headers.

    Request parameter

    The following describes the parameters.

    FieldTypeRequiredDescription
    regionCodeStringOptionalRegion code
    • Region code of the Cloud DB for PostgreSQL instance for which you want to create a read replica server instance
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    cloudPostgresqlInstanceNoStringRequiredCloud DB for PostgreSQL instance number
    subnetNoStringConditionalSubnet number of the default network interface to be used in the Cloud DB for PostgreSQL instance
    • Check through getCloudPostgresqlTargetSubnetList
    • Required for a Cloud DB for PostgreSQL instance configured with multi-zone (isMultiZone=true)
    • For a Cloud DB for PostgreSQL instance whose multi-zone is not configured (isMultiZone=false), the subnetNo entry is ignored and it is created in the existing subnetNo
    • Subnet migrations are not available after creating the Cloud DB for PostgreSQL read replica instance
    responseFormatTypeStringOptionalFormat of the response result
    • xml (default) | json

    Request example

    The following is a sample request.

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/createCloudPostgresqlReadReplicaInstance
    ?regionCode=KR
    &cloudPostgresqlInstanceNo=****925
    &subnetNo=****51'
    --header 'x-ncp-apigw-timestamp: {Timestamp}' 
    --header 'x-ncp-iam-access-key: {Access Key}' 
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    Response

    The following describes the response format.

    Response body

    See CloudPostgresqlInstanceList for the response body.

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    The following is a sample response.

    • If responseFormatType=json
    {
        "createCloudPostgresqlReadReplicaInstanceResponse": {
            "totalRows": 1,
            "cloudPostgresqlInstanceList": [
                {
                    "cloudPostgresqlInstanceNo": "****925",
                    "cloudPostgresqlServiceName": "test-****",
                    "cloudPostgresqlInstanceStatusName": "running",
                    "cloudPostgresqlInstanceStatus": {
                        "code": "CREAT",
                        "codeName": "CLOUD DATABASE(VPC) Created State"
                    },
                    "cloudPostgresqlInstanceOperation": {
                        "code": "NULL",
                        "codeName": "CLOUD DATABASE(VPC) Null OP"
                    },
                    "cloudPostgresqlImageProductCode": "SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050",
                    "engineVersion": "PostgreSQL 13.3",
                    "generationCode": "G2",
                    "license": "PostgreSQL License",
                    "cloudPostgresqlPort": 15432,
                    "isHa": true,
                    "isMultiZone": true,
                    "isBackup": true,
                    "backupFileRetentionPeriod": 10,
                    "backupTime": "02:00",
                    "createDate": "2024-06-03T10:47:11+0900",
                    "accessControlGroupNoList": [
                        "180946"
                    ],
                    "cloudPostgresqlConfigList": [
                        "sample_config=sample_value"
                    ],
                    "cloudPostgresqlServerInstanceList": [
                        {
                            "cloudPostgresqlServerInstanceNo": "****926",
                            "cloudPostgresqlServerName": "test-****-001-523a",
                            "cloudPostgresqlServerRole": {
                                "code": "M",
                                "codeName": "Primary"
                            },
                            "cloudPostgresqlServerInstanceStatusName": "running",
                            "cloudPostgresqlServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudPostgresqlServerInstanceOperation": {
                                "code": "NOOP",
                                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                            },
                            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****87",
                            "subnetNo": "****49",
                            "isPublicSubnet": true,
                            "privateDomain": "pg-****.vpc-cdb-kr.ntruss.com",
                            "privateIp": "***.***.***.***",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "isStorageEncryption": true,
                            "dataStorageSize": 10737418240,
                            "usedDataStorageSize": 142819911,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "uptime": "2024-06-03T10:54:38+0900",
                            "createDate": "2024-06-03T10:47:11+0900"
                        },
                        {
                            "cloudPostgresqlServerInstanceNo": "****932",
                            "cloudPostgresqlServerName": "test-****-002-523b",
                            "cloudPostgresqlServerRole": {
                                "code": "H",
                                "codeName": "Secondary"
                            },
                            "cloudPostgresqlServerInstanceStatusName": "running",
                            "cloudPostgresqlServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudPostgresqlServerInstanceOperation": {
                                "code": "NOOP",
                                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                            },
                            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M008.NET.SSD.B050.G002",
                            "regionCode": "KR",
                            "zoneCode": "KR-2",
                            "vpcNo": "****87",
                            "subnetNo": "****51",
                            "isPublicSubnet": true,
                            "privateDomain": "pg-****.vpc-cdb-kr.ntruss.com",
                            "privateIp": "***.***.***.***",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "isStorageEncryption": true,
                            "dataStorageSize": 10737418240,
                            "usedDataStorageSize": 92188723,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "uptime": "2024-06-03T10:54:38+0900",
                            "createDate": "2024-06-03T10:47:11+0900"
                        },
                        {
                            "cloudPostgresqlServerName": "test-****-003-5257",
                            "cloudPostgresqlServerRole": {
                                "code": "S",
                                "codeName": "Read Replica"
                            },
                            "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,
                            "privateIp": "***.***.***.***",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "isStorageEncryption": true,
                            "dataStorageSize": 10737418240,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "createDate": "2024-06-03T13:32:57+0900"
                        }
                    ]
                }
            ],
            "requestId": "435bac03-****-****-****-2f5f39f3245e",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • If responseFormatType=xml (default)
    <?xml version="1.0" encoding="UTF-8"?>
    <createCloudPostgresqlReadReplicaInstanceResponse>
        <requestId>435bac03-****-****-****-2f5f39f3245e</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudPostgresqlInstanceList>
            <cloudPostgresqlInstance>
                <cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
                <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
                <cloudPostgresqlInstanceStatusName>running</cloudPostgresqlInstanceStatusName>
                <cloudPostgresqlInstanceStatus>
                    <code>CREAT</code>
                    <codeName>CLOUD DATABASE(VPC) Created State</codeName>
                </cloudPostgresqlInstanceStatus>
                <cloudPostgresqlInstanceOperation>
                    <code>NULL</code>
                    <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
                </cloudPostgresqlInstanceOperation>
                <cloudPostgresqlImageProductCode>SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050</cloudPostgresqlImageProductCode>
                <engineVersion>PostgreSQL 13.3</engineVersion>
                <generationCode>G2</generationCode>
                <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>
                    <accessControlGroupNo>****48</accessControlGroupNo>
                </accessControlGroupNoList>
                <cloudPostgresqlConfigList>
                    <cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
                </cloudPostgresqlConfigList>
                <cloudPostgresqlServerInstanceList>
                    <cloudPostgresqlServerInstance>
                        <cloudPostgresqlServerInstanceNo>****926</cloudPostgresqlServerInstanceNo>
                        <cloudPostgresqlServerName>test-****-001-523a</cloudPostgresqlServerName>
                        <cloudPostgresqlServerRole>
                            <code>M</code>
                            <codeName>Primary</codeName>
                        </cloudPostgresqlServerRole>
                        <cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
                        <cloudPostgresqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudPostgresqlServerInstanceStatus>
                        <cloudPostgresqlServerInstanceOperation>
                            <code>NOOP</code>
                            <codeName>CLOUD DATABASE(VPC) Server Null 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>
                        <privateDomain>pg-****.vpc-cdb-kr.ntruss.com</privateDomain>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <usedDataStorageSize>117703804</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <uptime>2024-06-03T10:54:38+0900</uptime>
                        <createDate>2024-06-03T10:47:11+0900</createDate>
                    </cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstance>
                        <cloudPostgresqlServerInstanceNo>****932</cloudPostgresqlServerInstanceNo>
                        <cloudPostgresqlServerName>test-****-002-523b</cloudPostgresqlServerName>
                        <cloudPostgresqlServerRole>
                            <code>H</code>
                            <codeName>Secondary</codeName>
                        </cloudPostgresqlServerRole>
                        <cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
                        <cloudPostgresqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudPostgresqlServerInstanceStatus>
                        <cloudPostgresqlServerInstanceOperation>
                            <code>NOOP</code>
                            <codeName>CLOUD DATABASE(VPC) Server Null 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>
                        <privateDomain>pg-****.vpc-cdb-kr.ntruss.com</privateDomain>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <usedDataStorageSize>67226304</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <uptime>2024-06-03T10:54:56+0900</uptime>
                        <createDate>2024-06-03T10:47:11+0900</createDate>
                    </cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstance>
                        <cloudPostgresqlServerName>test-****-003-5257</cloudPostgresqlServerName>
                        <cloudPostgresqlServerRole>
                            <code>S</code>
                            <codeName>Read Replica</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>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <createDate>2024-06-03T13:32:57+0900</createDate>
                    </cloudPostgresqlServerInstance>
                </cloudPostgresqlServerInstanceList>
            </cloudPostgresqlInstance>
        </cloudPostgresqlInstanceList>
    </createCloudPostgresqlReadReplicaInstanceResponse>
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.