getCloudPostgresqlInstanceDetail
    • PDF

    getCloudPostgresqlInstanceDetail

    • PDF

    記事の要約

    VPC環境で利用できます。

    Cloud DB for PostgreSQLインスタンスの詳細情報を照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET, POST/getCloudPostgresqlInstanceDetail

    リクエストヘッダ

    Cloud DB for PostgreSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for PostgreSQL (VPC)のリクエストヘッダをご参照ください。

    リクエストパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    regionCodeStringOptionalリージョンコード
    • 照会対象の Cloud DB for PostgreSQLインスタンスのリージョンコード
    • getRegionListを通じて確認
    • getRegionList照会結果の最初のリージョン(デフォルト)
    cloudPostgresqlInstanceNoStringRequiredCloud DB for PostgreSQLインスタンス番号
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

    リクエストのサンプルコードは次の通りです。

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

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの詳細は、CloudPostgresqlInstanceListをご参照ください。

    レスポンスステータスコード

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    • responseFormatType=jsonの場合
    {
        "getCloudPostgresqlInstanceDetailResponse": {
            "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",
                    "generationCode": "G2",
                    "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": [
                        "182422"
                    ],
                    "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": 117705817,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "uptime": "2024-06-04T14:17:10+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": 67231299,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "uptime": "2024-06-04T14:17:10+0900",
                            "createDate": "2024-06-03T10:47:11+0900"
                        }
                    ]
                }
            ],
            "requestId": "331cca88-****-****-****-ba59a04e17e1",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • responseFormatType=xml(デフォルト)の場合
    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudPostgresqlInstanceDetailResponse>
        <requestId>331cca88-****-****-****-ba59a04e17e1</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>
                <generationCode>G2</generationCode>
                <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>
                    <accessControlGroupNo>182422</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>117705817</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <uptime>2024-06-04T14:17:10+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>38948</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>67231299</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <uptime>2024-06-04T14:17:10+0900</uptime>
                        <createDate>2024-06-03T10:47:11+0900</createDate>
                    </cloudPostgresqlServerInstance>
                </cloudPostgresqlServerInstanceList>
            </cloudPostgresqlInstance>
        </cloudPostgresqlInstanceList>
    </getCloudPostgresqlInstanceDetailResponse>
    

    この記事は役に立ちましたか?

    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.