getCloudPostgresqlInstanceList
    • PDF

    getCloudPostgresqlInstanceList

    • PDF

    Article summary

    Available in VPC

    Get the list of Cloud DB for PostgreSQL instances.

    Request

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

    MethodURI
    GET, POST/getCloudPostgresqlInstanceList

    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 server instance to view
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    zoneCodeStringOptionalFilter by zone code
    vpcNoStringOptionalFilter by VPC number
    subnetNoStringOptionalFilter by subnet number
    cloudPostgresqlServiceNameStringOptionalFilter by Cloud DB for PostgreSQL service name
    cloudPostgresqlInstanceNoList.NList<String>OptionalCloud DB for PostgreSQL instance number list
    • Filter by Cloud DB for PostgreSQL instance number
    • Check through getCloudPostgresqlInstanceList
    • <E.g.> cloudPostgresqlInstanceNoList.1=1234&cloudPostgresqlInstanceNoList.2=2345
    cloudPostgresqlServerNameStringOptionalFilter by Cloud DB for PostgreSQL server name
    cloudPostgresqlServerInstanceNoList.NList<String>OptionalCloud DB for PostgreSQL server instance number list
    • Filter by Cloud DB for PostgreSQL server instance number
    • Check through getCloudPostgresqlInstanceList
    • <E.g.> cloudPostgresqlServerInstanceNoList.1=1234&cloudPostgresqlServerInstanceNoList.2=2345
    pageNoIntegerOptionalPage numbers in paged results
    • Page the result values using pageNo and pageSize
    • 0 (minimum)
    pageSizeIntegerConditionalNumber of results to display on a page
    • Page the result values using pageNo and pageSize
    • Required when entering pageNo
    • 1 (minimum)
    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/getCloudPostgresqlInstanceList
    ?regionCode=KR' 
    --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
    {
        "getCloudPostgresqlInstanceListResponse": {
            "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"
                    },
                    "isHa": true,
                    "isMultiZone": true,
                    "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****87",
                            "subnetNo": "****49",
                            "dataStorageSize": 10737418240,
                            "cpuCount": 2,
                            "memorySize": 8589934592
                        },
                        {
                            "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-2",
                            "vpcNo": "****87",
                            "subnetNo": "****51",
                            "dataStorageSize": 10737418240,
                            "cpuCount": 2,
                            "memorySize": 8589934592
                        }
                    ]
                }
            ],
            "requestId": "5092443c-****-****-****-7e916678d405",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • If responseFormatType=xml (default)
    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudPostgresqlInstanceListResponse>
        <requestId>5092443c-****-****-****-7e916678d405</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>
                <isHa>true</isHa>
                <isMultiZone>true</isMultiZone>
                <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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****87</vpcNo>
                        <subnetNo>****49</subnetNo>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                    </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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-2</zoneCode>
                        <vpcNo>****87</vpcNo>
                        <subnetNo>****51</subnetNo>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                    </cloudPostgresqlServerInstance>
                </cloudPostgresqlServerInstanceList>
            </cloudPostgresqlInstance>
        </cloudPostgresqlInstanceList>
    </getCloudPostgresqlInstanceListResponse>
    

    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.