getCloudMssqlInstanceDetail

인쇄
공유
PDF

기사 요약

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

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

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

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

명령어

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

ncloud vmssql getCloudMssqlInstanceDetail [regionCode] [cloudMssqlInstanceNo] [output]

파라미터

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

파라미터	타입	필수 여부	설명	제약 사항
regionCode	String	N	리전 코드 - regionCode는 getRegionList 액션을 통해서 획득 - default: getRegionList 조회 결과의 첫 번째 리전을 선택	-
cloudMssqlInstanceNo	String	Y	Cloud DB for MSSQL 인스턴스 번호 - 상세 정보를 조회할 Cloud DB for MSSQL 인스턴스 번호를 입력 - cloudMssqlInstanceNo는 getCloudMssqlInstanceList 액션을 통해서 획득	-
output	String	N	응답 결과의 포맷 타입 - options: xml \| json - default: json	-

응답

응답 데이터 타입

CloudMssqlInstanceList 타입

CloudMssqlInstanceList extends CommonResponse	설명
private Integer totalRows;	조회된 목록의 총 개수
private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>();	Cloud DB for MSSQL 인스턴스 목록

CloudMssqlInstance 타입

CloudMssqlInstance	설명
private String cloudMssqlInstanceNo;	Cloud DB for MSSQL 인스턴스 번호
private String cloudMssqlServiceName;	Cloud DB for MSSQL 서비스 이름
private String cloudMssqlInstanceStatusName;	Cloud DB for MSSQL 인스턴스 상태 이름 - `creating` - `deleted` - `deleting` - `downgrading` - `pending` - `recovering` - `reinstalling` - `restarting` - `running` - `settingup` - `shuttingdown` - `stopped` - `upgrading`
private CommonCode cloudMssqlInstanceStatus;	Cloud DB for MSSQL 인스턴스 상태 코드 - `INIT (initiate)` - `CREAT (created)` - `DEL (deleted)`
private CommonCode cloudMssqlInstanceOperation;	Cloud DB for MSSQL 인스턴스 Operation 코드 - `CREAT (create)` - `DEL (delete)` - `FO (failover)` - `NULL (no operation)` - `SETUP (setup)` - `UPGD (upgrade)` - `DWGD (downgrade)` - `BKP (backup)`
private String cloudMssqlImageProductCode;	Cloud DB for MSSQL 이미지 상품 코드
private Boolean isHa;	고가용성 여부
private Boolean isMultiZone;	멀티존 여부
private CommonCode license;	Cloud DB for MSSQL 라이선스
private Integer cloudMssqlPort;	Cloud DB for MSSQL 포트
private Integer backupFileRetentionPeriod;	백업 파일 보관 기간
private String backupTime;	백업 시간
private String configGroupNo;	Cloud DB for MSSQL Config Group 번호
private String configGroupName;	Cloud DB for MSSQL Config Group 이름
private String engineVersion;	Cloud DB for MSSQL 엔진 버전
private Date createDate;	생성일자
private String dbCollation;	Cloud DB for MSSQL 문자셋
private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList;	Cloud DB for MSSQL 서버 인스턴스 목록
private AccessControlGroupNoList accessControlGroupNoList;	ACG 번호 목록

CloudMssqlServerInstance 타입

CloudMssqlServerInstance	설명
private String cloudMssqlServerInstanceNo;	Cloud DB for MSSQL 서버 인스턴스 번호
private String cloudMssqlServerName;	Cloud DB for MSSQL 서버 이름
private CommonCode cloudMssqlServerRole;	Cloud DB for MSSQL 서버 역할
private String cloudMssqlServerInstanceStatusName;	Cloud DB for MSSQL 서버 인스턴스 상태 이름 - `creating` - `deleted` - `deleting` - `downgrading` - `pending` - `recovering` - `reinstalling` - `restarting` - `running` - `settingup` - `shuttingdown` - `stopped` - `upgrading` - `downgrading`
private CommonCode cloudMssqlServerInstanceStatus;	Cloud DB for MSSQL 서버 인스턴스 상태 코드 - `DEL (deleted)` - `PEND (pending)` - `RUN (running)` - `STOP (stopped)` - `FSTOP (failure stopped)`
private CommonCode cloudMssqlServerInstanceOperation;	Cloud DB for MSSQL 서버 인스턴스 Operation 코드 - `NOOP (no operation)` - `CREAT (create)` - `START (start)` - `RSTRT (restart)` - `SETUP (setup)` - `STOP (stop)` - `FO (failover)` - `DEL (delete)` - `UPGD (upgrade)` - `DWGD (downgrade)` - `RISTL (reinstall)`
private String regionCode;	리전 코드
private String zoneCode;	Zone 코드
private String vpcNo;	VPC 번호
private String subnetNo;	Subnet 번호
private Long dataStorageSize;	데이터 스토리지 사이즈
private Integer cpuCount;	CPU 개수
private Long memorySize;	메모리 사이즈
private Boolean isPublicSubnet;	Public Subnet 여부
private String cloudMssqlProductCode;	Cloud DB for MSSQL 상품 코드
private String privateDomain;	사설 도메인명
private String publicDomain;	공인 도메인명
private Date createDate;	생성일자
private Date uptime;	VM 부팅 완료 시간
private CommonCode dataStorageType;	데이터 스토리지 타입
private Long usedDataStorageSize;	사용중인 데이터 스토리지 사이즈

AccessControlGroupNoList 타입
AccessControlGroupNoList 설명
private List<String> accessControlGroupNoList = new ArrayList<>(); ACG 번호 목록

AccessControlGroupNoList	설명
private List<String> accessControlGroupNoList = new ArrayList<>();	ACG 번호 목록

예시

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

호출 예시

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

ncloud vmssql getCloudMssqlInstanceDetail --regionCode KR --cloudMssqlInstanceNo ****890

응답 예시

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

응답 결과 포맷 타입(output)이 json인 경우

응답 결과 포맷 타입(output)이 json인 경우는 다음과 같습니다.

{
  "getCloudMssqlInstanceDetailResponse": {
    "requestId": "c04bfdd1-e27e-4006-9bc3-bc37840ce1dd",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100",
        "isHa": true,
        "isMultiZone": false,
        "license": {
          "code": "GPL",
          "codeName": "General Public License"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 10,
        "backupTime": "00:15",
        "configGroupNo": "**9",
        "configGroupName": "test-****-config",
        "engineVersion": "MSSQL 15.0.2000.5 Standard Edition",
        "createDate": "2021-04-12T19:30:38+0900",
        "cloudMssqlServerInstanceList": [
          {
           "cloudMssqlServerInstanceNo": "****891",
           "cloudMssqlServerName": "m-****890-001",
           "cloudMssqlServerRole": {
             "code": "M",
             "codeName": "Principal"
           },
           "cloudMssqlServerInstanceStatusName": "running",
           "cloudMssqlServerInstanceStatus": {
             "code": "RUN",
             "codeName": "CLOUD DATABASE(VPC) Server Running State"
           },
           "cloudMssqlServerInstanceOperation": {
             "code": "NOOP",
             "codeName": "CLOUD DATABASE(VPC) Server Null OP"
           },
           "regionCode": "KR",
           "zoneCode": "KR-1",
           "vpcNo": "****83",
           "subnetNo": "****91",
           "dataStorageSize": 107374182400,
           "cpuCount": 2,
           "memorySize": 8589934592,
           "isPublicSubnet": true,
           "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
           "privateDomain": "mssql-***.beta-vpc-cdb.ntruss.com",
           "createDate": "2021-04-30T14:03:20+0900",
           "uptime": "2021-04-30T14:14:39+0900",
           "dataStorageType": {
             "code": "SSD",
             "codeName": "SSD"
           },
           "usedDataStorageSize": 1073741824
          },
          {
           "cloudMssqlServerInstanceNo": "****897",
           "cloudMssqlServerName": "m-****890-002",
           "cloudMssqlServerRole": {
             "code": "H",
             "codeName": "Mirror"
           },
           "cloudMssqlServerInstanceStatusName": "running",
           "cloudMssqlServerInstanceStatus": {
             "code": "RUN",
             "codeName": "CLOUD DATABASE(VPC) Server Running State"
           },
           "cloudMssqlServerInstanceOperation": {
             "code": "NOOP",
             "codeName": "CLOUD DATABASE(VPC) Server Null OP"
           },
           "regionCode": "KR",
           "zoneCode": "KR-1",
           "vpcNo": "****83",
           "subnetNo": "****91",
           "dataStorageSize": 107374182400,
           "cpuCount": 2,
           "memorySize": 8589934592,
           "isPublicSubnet": true,
           "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
           "privateDomain": "mssql-***.beta-vpc-cdb.ntruss.com",
           "createDate": "2021-05-27T19:00:00+0900",
           "uptime": "2021-05-27T19:01:00+0900",
           "dataStorageType": {
             "code": "SSD",
             "codeName": "SSD"
           },
           "usedDataStorageSize": 1073741824
          }
        ]
      }
    ],
    "accessControlGroupNoList": []
  }
}

응답 결과 포맷 타입(responseFormatType)이 xml인 경우

응답 결과 포맷 타입(responseFormatType)이 xml인 경우는 다음과 같습니다.

<getCloudMssqlInstanceDetailResponse>
    <requestId>c04bfdd1-e27e-4006-9bc3-bc37840ce1dd</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
            <cloudMssqlInstanceStatusName>running</cloudMssqlInstanceStatusName>
            <cloudMssqlInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudMssqlInstanceStatus>
            <cloudMssqlInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudMssqlInstanceOperation>
            <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100</cloudMssqlImageProductCode>
            <isHa>true</isHa>
            <isMultiZone>false</isMultiZone>
            <license>
                <code>GPL</code>
                <codeName>General Public License</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>00:15</backupTime>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>test-****-config</configGroupName>
            <engineVersion>MSSQL 15.0.2000.5 Standard Edition</engineVersion>
            <createDate>2021-04-12T19:30:38+0900</createDate>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstanceNo>****891</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-****890-001</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>M</code>
                        <codeName>Principal</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMssqlServerInstanceStatus>
                    <cloudMssqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMssqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-***.beta-vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2021-04-30T14:03:20+0900</createDate>
                    <uptime>2021-04-30T14:14:39+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstanceList>
                <cloudMssqlServerInstanceList>
                    <cloudMssqlServerInstanceNo>****897</cloudMssqlServerInstanceNo>
                    <cloudMssqlServerName>m-****890-002</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>H</code>
                        <codeName>Mirror</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMssqlServerInstanceStatus>
                    <cloudMssqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMssqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>107374182400</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <privateDomain>mssql-***.beta-vpc-cdb.ntruss.com</privateDomain>
                    <createDate>2021-05-27T19:00:00+0900</createDate>
                    <uptime>2021-05-27T19:01:00+0900</uptime>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <usedDataStorageSize>1073741824</usedDataStorageSize>
                </cloudMssqlServerInstanceList>
            </cloudMssqlServerInstanceList>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
    <accessControlGroupNoList/>
</getCloudMssqlInstanceDetailResponse>

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

What's Next

getCloudMssqlInstanceList

명령어
응답
예시

태그