명령어

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

ncloud vmssql getCloudMssqlInstanceList [cloudMssqlInstanceNoList] [cloudMssqlServiceName] [cloudMssqlServerInstanceNoList] [cloudMssqlServerName] [regionCode] [zoneCode] [vpcNo] [subnetNo] [pageNo] [pageSize] [output]

파라미터

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

파라미터	타입	필수 여부	설명	제약 사항
cloudMssqlInstanceNoList	List<String>	N	Cloud DB for MSSQL 인스턴스 번호 목록 - Cloud DB for MSSQL 인스턴스 번호로 필터링하여 검색 가능 - cloudMssqlInstanceNoList는 getCloudMssqlInstanceList 액션을 통해서 획득 - ex) cloudMssqlInstanceNoList 1234 2345	-
cloudMssqlServiceName	String	N	Cloud DB for MSSQL 서비스 이름 - Cloud DB for MSSQL 서비스 이름으로 필터링하여 검색 가능 - cloudMssqlServiceName은 getCloudMssqlInstanceList 액션을 통해서 획득	-
cloudMssqlServerInstanceNoList	List<String>	N	Cloud DB for MSSQL 서버 인스턴스 번호 목록 - Cloud DB for MSSQL 서버 인스턴스 번호로 필터링하여 검색 가능 - cloudMssqlServerInstanceNoList getCloudMssqlInstanceList 액션을 통해서 획득 - ex) cloudMssqlServerInstanceNoList 1234 2345	-
cloudMssqlServerName	String	N	Cloud DB for MSSQL 서버 이름 - Cloud DB for MSSQL 서버 이름으로 필터링하여 검색 가능 - cloudMssqlServerName은 getCloudMssqlInstanceList 액션을 통해서 획득	-
regionCode	String	N	리전 코드 - regionCode는 getRegionList 액션을 통해서 획득 - default: getRegionList 조회 결과의 첫 번째 리전을 선택	-
zoneCode	String	N	Zone 코드 - zoneCode는 getZoneList 액션을 통해서 획득	-
vpcNo	String	N	VPC 번호 - vpcNo는 getCloudMssqlTargetVpcList 액션을 통해서 획득	-
subnetNo	String	N	Subnet 번호 - SubnetNo는 getCloudMssqlTargetSubnetList 액션을 통해서 획득	-
pageNo	Integer	N	페이징 된 결과의 페이지 번호 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능	- Min: 0
pageSize	Integer	N	페이징 시 보여줄 각 페이지 사이즈 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 - pageNo 입력시 반드시 입력	- Min: 1
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)` - `FW (Failover waiting)`
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 getCloudMssqlInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***83 --subnetNo **91 --cloudMssqlServiceName test-**** --cloudMssqlInstanceNoList ****890 --cloudMssqlServerName test--**** --cloudMssqlServerInstanceNoList ****891 --pageNo 0 --pageSize 10

응답 예시

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

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

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

{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "*****90",
        "cloudMssqlServiceName": "******",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "******91",
            "cloudMssqlServerName": "*******001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          },
          {
            "cloudMssqlServerInstanceNo": "********",
            "cloudMssqlServerName": "*********002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          }
        ]
      }
    ],
    "requestId": "*********************************",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

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

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

<getCloudMssqlInstanceListResponse>
    <requestId>*********************************</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
      <cloudMssqlInstance>
        <cloudMssqlInstanceNo>*******</cloudMssqlInstanceNo>
        <cloudMssqlServiceName>*******</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>
        <cloudMssqlServerInstanceList>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>*******</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>*******</cloudMssqlServerName>
            <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>
            <vpcNo>*****</vpcNo>
            <subnetNo>*****</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>********</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>********</cloudMssqlServerName>
            <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>
            <vpcNo>*****</vpcNo>
            <subnetNo>******</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
        </cloudMssqlServerInstanceList>
      </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</getCloudMssqlInstanceListResponse>

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

명령어
- 파라미터
응답
- 응답 데이터 타입
예시
- 호출 예시
- 응답 예시

태그