getCloudPostgresqlInstanceDetail
    • PDF

    getCloudPostgresqlInstanceDetail

    • PDF

    기사 요약

    Cloud DB for PostgreSQL 인스턴스 상세 정보를 조회합니다.

    명령어

    명령어 구문은 다음과 같습니다.

    ncloud vpostgresql getCloudPostgresqlInstanceDetail [regionCode] [cloudPostgresqlInstanceNo] [output]
    

    파라미터

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

    파라미터타입필수 여부설명제약 사항
    regionCodeStringN리전 코드
    - regionCode는 getRegionList 액션을 통해 획득
    - default: getRegionList 조회 결과의 첫 번째 리전을 선택
    -
    cloudPostgresqlInstanceNoStringYCloud DB for PostgreSQL 인스턴스 번호
    - cloudPostgresqlInstanceNo는 getCloudPostgresqlInstanceList 액션을 통해 획득
    -
    outputStringN응답 결과의 포맷 타입
    - options: xml | json
    - default: json
    -

    응답

    응답 데이터 타입

    • CloudPostgresqlInstanceList 타입
    CloudPostgresqlInstanceList extends CommonResponse
    private Integer totalRows;
    private List<CloudPostgresqlInstance> cloudPostgresqlInstanceList = new ArrayList<>();
    • CloudPostgresqlInstance 타입
    CloudPostgresqlInstance
    private String cloudPostgresqlInstanceNo;
    private String cloudPostgresqlServiceName;
    private String cloudPostgresqlInstanceStatusName;
    private CommonCode cloudPostgresqlInstanceStatus;
    private CommonCode cloudPostgresqlInstanceOperation;
    private String cloudPostgresqlImageProductCode;
    private String engineVersion;
    private String generationCode;
    private String license;
    private Integer cloudPostgresqlPort;
    private Boolean isHa;
    private Boolean isMultiZone;
    private Boolean isBackup;
    private Integer backupFileRetentionPeriod;
    private String backupTime;
    private Date createDate;
    private AccessControlGroupNoList accessControlGroupNoList;
    private CloudPostgresqlConfigList cloudPostgresqlConfigList;
    private List<CloudPostgresqlServerInstance> cloudPostgresqlServerInstanceList;
    • AccessControlGroupNoList 타입
    AccessControlGroupNoList
    private List<String> accessControlGroupNoList = new ArrayList<>();
    • CloudPostgresqlConfigList 타입
    CloudPostgresqlConfigList
    private List<String> cloudPostgresqlConfigList = new ArrayList<>();
    • CloudPostgresqlServerInstance 타입
    CloudPostgresqlServerInstance
    private String cloudPostgresqlServerInstanceNo;
    private String cloudPostgresqlServerName;
    private CommonCode cloudPostgresqlServerRole;
    private String cloudPostgresqlServerInstanceStatusName;
    private CommonCode cloudPostgresqlServerInstanceStatus;
    private CommonCode cloudPostgresqlServerInstanceOperation;
    private String cloudPostgresqlProductCode;
    private String regionCode;
    private String zoneCode;
    private String vpcNo;
    private String subnetNo;
    private Boolean isPublicSubnet;
    private String publicDomain;
    private String privateDomain;
    private String privateIp;
    private CommonCode dataStorageType;
    private Boolean isStorageEncryption;
    private Long dataStorageSize;
    private Long usedDataStorageSize;
    private Integer cpuCount;
    private Long memorySize;
    private Date uptime;
    private Date createDate;

    예시

    호출과 응답 예시를 설명합니다.

    호출 예시

    호출 예시는 다음과 같습니다.

    ncloud vpostgresql getCloudPostgresqlInstanceDetail --regionCode FKR --cloudPostgresqlInstanceNo ****925
    

    응답 예시

    응답 예시는 다음과 같습니다.

    응답 결과 포맷 타입(output)이 json 일 때

    {
      "getCloudPostgresqlInstanceDetailResponse": {
        "requestId": "15ec23ff-2e64-43d1-b6a2-733bf5c3d3e1",
        "returnCode": 0,
        "returnMessage": "success",
        "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": "2021-08-30T18:00:00+0900",
            "accessControlGroupNoList": [
              "****48"
            ],
            "cloudPostgresqlConfigList": [
                "sample_config=sample_value"
            ],
            "cloudPostgresqlServerInstanceList": [
              {
                "cloudPostgresqlServerInstanceNo": "****926",
                "cloudPostgresqlServerName": "test-****-001-gcb",
                "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.M004.NET.SSD.B050.G001",
                "regionCode": "FKR",
                "zoneCode": "FKR-1",
                "vpcNo": "****87",
                "subnetNo": "****49",
                "isPublicSubnet": true,
                "privateDomain": "pg-****.vpc-cdb-fkr.fin-ntruss.com",
                "privateIp": "***.***.***.***",
                "dataStorageType": {
                  "code": "SSD",
                  "codeName": "SSD"
                },
                "isStorageEncryption": true,
                "dataStorageSize": 10737418240,
                "usedDataStorageSize": 4365680640,
                "cpuCount": 2,
                "memorySize": 4294967296,
                "uptime": "2021-08-30T18:10:00+0900",
                "createDate": "2021-08-30T18:00:00+0900"
              },
              {
                "cloudPostgresqlServerInstanceNo": "****932",
                "cloudPostgresqlServerName": "test-****-002-gcc",
                "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.M004.NET.SSD.B050.G001",
                "regionCode": "FKR",
                "zoneCode": "FKR-2",
                "vpcNo": "****87",
                "subnetNo": "****51",
                "isPublicSubnet": true,
                "privateDomain": "pg-****.vpc-cdb-fkr.fin-ntruss.com",
                "privateIp": "***.***.***.***",
                "dataStorageType": {
                  "code": "SSD",
                  "codeName": "SSD"
                },
                "isStorageEncryption": true,
                "dataStorageSize": 10737418240,
                "usedDataStorageSize": 3291672576,
                "cpuCount": 2,
                "memorySize": 4294967296,
                "uptime": "2021-08-30T18:10:00+0900",
                "createDate": "2021-08-30T18:00:00+0900"
              }
            ]
          }
        ]
      }
    }
    

    응답 결과 포맷 타입(output)이 xml 일 때

    <getCloudPostgresqlInstanceDetailResponse>
        <requestId>15ec23ff-2e64-43d1-b6a2-733bf5c3d3e1</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>2021-08-30T18:00:00+0900</createDate>
                <accessControlGroupNoList>
                    <accessControlGroupNo>****48</accessControlGroupNo>
                </accessControlGroupNoList>
                <cloudPostgresqlConfigList>
                    <cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
                </cloudPostgresqlConfigList>
                <cloudPostgresqlServerInstanceList>
                    <cloudPostgresqlServerInstance>
                        <cloudPostgresqlServerInstanceNo>****926</cloudPostgresqlServerInstanceNo>
                        <cloudPostgresqlServerName>test-****-001-gcb</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.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                        <regionCode>FKR</regionCode>
                        <zoneCode>FKR-1</zoneCode>
                        <vpcNo>****87</vpcNo>
                        <subnetNo>****49</subnetNo>
                        <isPublicSubnet>true</isPublicSubnet>
                        <privateDomain>pg-****.vpc-cdb-fkr.fin-ntruss.com</privateDomain>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <usedDataStorageSize>4365680640</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>4294967296</memorySize>
                        <uptime>2021-08-30T18:10:00+0900</uptime>
                        <createDate>2021-08-30T18:00:00+0900</createDate>
                    </cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstance>
                        <cloudPostgresqlServerInstanceNo>****932</cloudPostgresqlServerInstanceNo>
                        <cloudPostgresqlServerName>test-****-002-gcc</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.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                        <regionCode>FKR</regionCode>
                        <zoneCode>FKR-2</zoneCode>
                        <vpcNo>****87</vpcNo>
                        <subnetNo>****51</subnetNo>
                        <isPublicSubnet>true</isPublicSubnet>
                        <privateDomain>pg-****.vpc-cdb-fkr.fin-ntruss.com</privateDomain>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <usedDataStorageSize>3291672576</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>4294967296</memorySize>
                        <uptime>2021-08-30T18:10:00+0900</uptime>
                        <createDate>2021-08-30T18:00:00+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.