getCloudMysqlInstanceList
    • PDF

    getCloudMysqlInstanceList

    • PDF

    기사 요약

    Cloud DB for MySQL 인스턴스 목록을 조회합니다.

    명령어

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

    ncloud vmysql getCloudMysqlInstanceList [regionCode FKR] [vpcNo] [subnetNo] [cloudMysqlServiceName] [cloudMysqlInstanceNoList] [cloudMysqlServerName] [cloudMysqlServerInstanceNoList] [generationCode] [pageNo] [pageSize] [output]
    

    파라미터

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

    파라미터타입필수 여부설명제약 사항
    regionCodeStringNCloud DB for MySQL 인스턴스가 존재하는 리전 코드
    - getRegionList 액션을 통해서 획득 가능
    - default: getRegionList 조회 결과의 첫 번째 리전을 선택
    -
    zoneCodeStringNZONE 코드
    - getZoneList 액션을 통해서 획득 가능
    -
    vpcNoStringNVPC 번호
    - getCloudMysqlTargetVpcList 액션을 통해서 획득 가능
    -
    subnetNoStringNSubnet 번호
    - getCloudMysqlTargetSubnetList 액션을 통해서 획득 가능
    -
    cloudMysqlServiceNameStringNCloud DB for MySQL 서비스 이름
    - getCloudMysqlInstanceList 액션을 통해서 획득 가능
    -
    cloudMysqlInstanceNoListList<String>NCloud DB for MySQL 인스턴스 번호 목록
    - getCloudMysqlInstanceList 액션을 통해서 획득 가능
    <예시>
    - cloudMysqlInstanceNoList 1234 2345
    -
    cloudMysqlServerNameStringNCloud DB for MySQL 서버 이름
    - getCloudMysqlInstanceList 액션을 통해서 획득 가능
    -
    cloudMysqlServerInstanceNoListList<String>NCloud DB for MySQL 서버 인스턴스 번호 목록
    - getCloudMysqlInstanceList 액션을 통해서 획득 가능
    <예시>
    -cloudMysqlServerInstanceNoList 1234 2345
    -
    generationCodeStringN서버 세대 코드
    - options: G2 | G3
    -
    pageNoIntegerN페이징 된 결과의 페이지 번호
    - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
    min: 0
    pageSizeIntegerN페이징 시 보여줄 각 페이지 사이즈
    - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
    - pageNo 입력시 반드시 입력
    min: 1
    outputStringN응답 결과의 포맷 타입
    - options: xml | json
    - default: json
    -

    응답

    응답 데이터 타입

    명령어 호출에 대한 응답 데이터 타입은 다음과 같습니다.

    • CloudMysqlInstanceList 타입
    CloudMysqlInstanceList extends CommonResponse설명
    private Integer totalRows;조회된 목록의 총 개수
    private List<CloudMysqlInstance> cloudMysqlInstanceList = new ArrayList<>();
    • CloudMysqlInstance 타입
    CloudMysqlInstance설명
    private String cloudMysqlInstanceNo;Cloud DB for MySQL 인스턴스 번호
    private String cloudMysqlServiceName;Cloud DB for MySQL 서비스 이름
    private String cloudMysqlInstanceStatusName;Cloud DB for MySQL 인스턴스 상태 이름
    -creating
    -deleted
    -deleting
    -pending
    -recovering
    -reinstalling
    -restarting
    -running
    -settingup
    -shuttingdown
    -stopped
    -upgrading
    -downgrading
    private CommonCode cloudMysqlInstanceStatus;Cloud DB for MySQL 인스턴스 상태 코드
    -INIT (init)
    -CREAT (created)
    -DEL (deleted)
    private CommonCode cloudMysqlInstanceOperation;Cloud DB for MySQL 인스턴스 Operation 코드
    -CREAT (create)
    -DEL (delete)
    -FO (failover)
    -NULL (no)
    -SETUP (setup)
    -UPGD (upgrade)
    -DWGD (downgrade)
    -BKP (backup)
    private String cloudMysqlImageProductCode;Cloud DB for MySQL 이미지 상품 코드
    private String engineVersion;Cloud DB for MySQL 엔진 버전
    private CommonCode license;Cloud DB for MySQL 라이선스
    private Integer cloudMysqlPort;Cloud DB for MySQL 포트
    private Boolean isHa;고가용성 여부
    private Boolean isMultiZone;멀티존 여부
    private Boolean isBackup;백업 여부
    private Integer backupFileRetentionPeriod;백업 파일 보관 기간
    private String backupTime;백업 시간
    private String generationCode;서버 세대 코드
    private Date createDate;생성일자
    private List<String> accessControlGroupNoList;ACG 번호 목록
    private List<String> cloudMysqlConfigList;Cloud DB for MySQL Config 목록
    private List<CloudMysqlServerInstance> cloudMysqlServerInstanceList;Cloud DB for MySQL 서버 인스턴스 목록
    • CloudMysqlServerInstance 타입
    CloudMysqlServerInstance설명
    private String cloudMysqlServerInstanceNo;Cloud DB for MySQL 서버 인스턴스 번호
    private String cloudMysqlServerName;Cloud DB for MySQL 서버 이름
    private CommonCode cloudMysqlServerRole;Cloud DB for MySQL 서버 역할
    private String cloudMysqlServerInstanceStatusName;Cloud DB for MySQL 서버 인스턴스 상태 이름
    -creating
    -deleted
    -deleting
    -downgrading
    -pending
    -recovering
    -reinstalling
    -restarting
    -running
    -settingup
    -shuttingdown
    -stopped
    -upgrading
    -downgrading
    private CommonCode cloudMysqlServerInstanceStatus;Cloud DB for MySQL 서버 인스턴스 상태 코드
    -DEL (deleted)
    -PEND (pending)
    -RUN (running)
    -STOP (stopped)
    -FSTOP (failure stopped)
    private CommonCode cloudMysqlServerInstanceOperation;Cloud DB for MySQL 서버 인스턴스 Operation 코드
    -NOOP (no operation)
    -CREAT (create)
    -START (start)
    -RSTRT (restart)
    -SETUP (setup)
    -STOP (stop)
    -FO (failover)
    -DEL (delete)
    -UPGD (upgrade)
    -DWGD (downgrade)
    -RISTL (서버 reinstall)
    -MIG (migration)
    private String cloudMysqlProductCode;Cloud DB for MySQL 상품 코드
    private String regionCode;리전 코드
    private String zoneCode;ZONE 코드
    private String vpcNo;VPC 번호
    private String subnetNo;Subnet 번호
    private Boolean isPublicSubnet;Public Subnet 여부
    private String publicDomain;공인 도메인명
    private String privateDomain;사설 도메인명
    private String privateIp;내부 IP
    private CommonCode dataStorageType;데이터 스토리지 타입
    private Boolean isStorageEncryption;데이터 스토리지 암호화 여부
    private Long dataStorageSize;데이터 스토리지 사이즈
    private Long usedDataStorageSize;사용중인 데이터 스토리지 사이즈
    private Integer cpuCount;virtual CPU 개수
    private Long memorySize;메모리 사이즈
    private Date uptime;VM Booting 완료시간
    private Date createDate;생성일자

    예시

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

    호출 예시

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

    ncloud vmysql getCloudMysqlInstanceList --regionCode FKR --zoneCode FKR-2 --vpcNo ***83 --subnetNo **91 --cloudMysqlServiceName test-**** --cloudMysqlInstanceNoList ****890 --cloudMysqlServerName test-**** --cloudMysqlServerInstanceNoList ****891 --generationCode G2 --pageNo 0 --pageSize 10
    

    응답 예시

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

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

    {
      "getCloudMysqlInstanceListResponse": {
        "requestId": "1ae10c76-412d-4050-8911-42fa19a60a31",
        "returnCode": 0,
        "returnMessage": "success",
        "totalRows": 1,
        "cloudMysqlInstanceList": {
          "cloudMysqlInstance": {
            "cloudMysqlInstanceNo": "****890",
            "cloudMysqlServiceName": "test-****",
            "cloudMysqlInstanceStatusName": "running",
            "cloudMysqlInstanceStatus": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Created State"
            },
            "cloudMysqlInstanceOperation": {
              "code": "NULL",
              "codeName": "CLOUD DATABASE(VPC) Null OP"
            },
            "isHa": true,
            "isMultiZone": true,
            "generationCode": "G2",
            "cloudMysqlServerInstanceList": {
              "cloudMysqlServerInstance": [
                {
                  "cloudMysqlServerInstanceNo": "****891",
                  "cloudMysqlServerName": "test-****-001-e04",
                  "cloudMysqlServerRole": {
                    "code": "M",
                    "codeName": "Master"
                  },
                  "cloudMysqlServerInstanceStatusName": "running",
                  "cloudMysqlServerInstanceStatus": {
                    "code": "RUN",
                    "codeName": "CLOUD DATABASE(VPC) Server Running State"
                  },
                  "cloudMysqlServerInstanceOperation": {
                    "code": "NOOP",
                    "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                  },
                  "privateIp": "***.***.***.***",
                  "regionCode": "FKR",
                  "zoneCode": "FKR-1",
                  "vpcNo": "****83",
                  "subnetNo": "****91",
                  "dataStorageSize": 10737418240,
                  "cpuCount": 2,
                  "memorySize": 8589934592
                },
                {
                  "cloudMysqlServerInstanceNo": "****897",
                  "cloudMysqlServerName": "test-****-002-e05",
                  "cloudMysqlServerRole": {
                    "code": "H",
                    "codeName": "Standby Master"
                  },
                  "cloudMysqlServerInstanceStatusName": "running",
                  "cloudMysqlServerInstanceStatus": {
                    "code": "RUN",
                    "codeName": "CLOUD DATABASE(VPC) Server Running State"
                  },
                  "cloudMysqlServerInstanceOperation": {
                    "code": "NOOP",
                    "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                  },
                  "privateIp": "***.***.***.***",
                  "regionCode": "FKR",
                  "zoneCode": "FKR-2",
                  "vpcNo": "****83",
                  "subnetNo": "****93",
                  "dataStorageSize": 10737418240,
                  "cpuCount": 2,
                  "memorySize": 8589934592
                }
              ]
            }
          }
        }
      }
    }
    

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

    
    <getCloudMysqlInstanceListResponse>
        <requestId>1ae10c76-412d-4050-8911-42fa19a60a31</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMysqlInstanceList>
            <cloudMysqlInstance>
                <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
                <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
                <cloudMysqlInstanceStatusName>running</cloudMysqlInstanceStatusName>
                <cloudMysqlInstanceStatus>
                    <code>CREAT</code>
                    <codeName>CLOUD DATABASE(VPC) Created State</codeName>
                </cloudMysqlInstanceStatus>
                <cloudMysqlInstanceOperation>
                    <code>NULL</code>
                    <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
                </cloudMysqlInstanceOperation>
                <isHa>true</isHa>
                <isMultiZone>true</isMultiZone>
                <generationCode>G2</generationCode>
                <cloudMysqlServerInstanceList>
                    <cloudMysqlServerInstance>
                        <cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
                        <cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
                        <cloudMysqlServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudMysqlServerRole>
                        <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                        <cloudMysqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudMysqlServerInstanceStatus>
                        <cloudMysqlServerInstanceOperation>
                            <code>NOOP</code>
                            <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                        </cloudMysqlServerInstanceOperation>
                        <privateIp>***.***.***.***</privateIp>
                        <regionCode>FKR</regionCode>
                        <zoneCode>FKR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                    </cloudMysqlServerInstance>
                    <cloudMysqlServerInstance>
                        <cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
                        <cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
                        <cloudMysqlServerRole>
                            <code>H</code>
                            <codeName>Standby Master</codeName>
                        </cloudMysqlServerRole>
                        <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                        <cloudMysqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudMysqlServerInstanceStatus>
                        <cloudMysqlServerInstanceOperation>
                            <code>NOOP</code>
                            <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                        </cloudMysqlServerInstanceOperation>
                        <privateIp>***.***.***.***</privateIp>
                        <regionCode>FKR</regionCode>
                        <zoneCode>FKR-2</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****93</subnetNo>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                    </cloudMysqlServerInstance>
                </cloudMysqlServerInstanceList>
            </cloudMysqlInstance>
        </cloudMysqlInstanceList>
    </getCloudMysqlInstanceListResponse>
    

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

    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.