getCloudMssqlConfigGroupList

Prev Next

사용 가능한 Cloud DB for MSSQL Config Group 목록을 조회합니다.

명령어

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

ncloud vmssql getCloudMssqlConfigGroupList [regionCode] [configGroupNo] [configGroupName] [cloudMssqlInstanceNo] [cloudMssqlServiceName] [output]

파라미터

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

파라미터 타입 필수 여부 설명 제약 사항
regionCode String N 리전 코드
- regionCode는 getRegionList 액션을 통해서 획득
- default: getRegionList 조회 결과의 첫 번째 리전을 선택		 -
configGroupNo String N Cloud DB for MSSQL Config Group 번호 -
configGroupName String N Cloud DB for MSSQL Config Group 이름 -
cloudMssqlInstanceNo String N Cloud DB for MSSQL 인스턴스 번호
- cloudMssqlInstanceNo는 getCloudMssqlInstanceList 액션을 통해서 획득		 -
cloudMssqlServiceName String N Cloud DB for MSSQL 서비스 이름 -
output String N 응답 결과의 포맷 타입
- options: xml | json
- default: json		 -

응답

응답 데이터 타입

  • CloudMssqlConfigGroupList 타입
CloudMssqlConfigGroupList extends CommonResponse 설명
private Integer totalRows; 조회된 목록의 총 개수
private List<CloudMssqlConfigGroup> cloudMssqlConfigGroupList = new ArrayList<>(); Cloud DB for MSSQL Config Group 목록
  • CloudMssqlConfigGroup 타입
CloudMssqlConfigGroup 설명
private String configGroupNo; Cloud DB for MSSQL Config Group 번호
private String configGroupName; Cloud DB for MSSQL Config Group 이름
private String configGroupDescription; Cloud DB for MSSQL Config Group 설명
private CommonCode configGroupType; Cloud DB for MSSQL Config Group 타입
private String configGroupStatusName; Cloud DB for MSSQL Config Group 상태
private CommonCode configGroupStatus; Cloud DB for MSSQL Config Group 상태명
private Date createDate; Cloud DB for MSSQL Config Group 생성 일시
private Date modifyDate; Cloud DB for MSSQL Config Group 마지막 수정 일시
private List<Integer> cloudMssqlInstanceNoList; Cloud DB for MSSQL Config Group을 사용 중인 Cloud DB for MSSQL Instance 번호 목록

예시

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

호출 예시

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

ncloud vmssql getCloudMssqlConfigGroupList --regionCode FKR --cloudMssqlInstanceNo ****590

응답 예시

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

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

{
  "getCloudMssqlConfigGroupListResponse": {
    "requestId": "f8883b8a-d4b0-486d-8c6f-163a76c62209",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 2,
    "cloudMssqlConfigGroupList": [
      {
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "configGroupType": {
          "code": "SYSTEM",
          "codeName": "Config Group System Type"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running State"
        },
        "createDate": "2018-02-10T17:03:55+0900",
        "modifyDate": "2018-02-10T17:03:55+0900",
        "cloudMssqlInstanceNoList": [
          1698967
        ]
      },
      {
        "configGroupNo": "**9",
        "configGroupName": "cfg-***-test",
        "configGroupDescription": "ConfigGroup Description",
        "configGroupType": {
          "code": "USER",
          "codeName": "Config Group User Type"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running State"
        },
        "createDate": "2021-03-04T11:49:55+0900",
        "modifyDate": "2021-03-04T11:49:55+0900"
      }
    ]
  }
}

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

<getCloudMssqlConfigGroupListResponse>
    <requestId>f8883b8a-d4b0-486d-8c6f-163a76c62209</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMssqlConfigGroupList>
        <CloudMssqlConfigGroup>
            <configGroupNo>0</configGroupNo>
            <configGroupName>mssql_2019_default</configGroupName>
            <configGroupType>
                <code>SYSTEM</code>
                <codeName>Config Group System Type</codeName>
            </configGroupType>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <createDate>2018-02-10T17:03:55+0900</createDate>
            <modifyDate>2018-02-10T17:03:55+0900</modifyDate>
            <cloudMssqlInstanceNoList>
                <int>1698967</int>
            </cloudMssqlInstanceNoList>
        </CloudMssqlConfigGroup>
        <CloudMssqlConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>cfg-***-test</configGroupName>
            <configGroupDescription>ConfigGroup Description</configGroupDescription>
            <configGroupType>
                <code>USER</code>
                <codeName>Config Group User Type</codeName>
            </configGroupType>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <createDate>2021-03-04T11:49:55+0900</createDate>
            <modifyDate>2021-03-04T11:49:55+0900</modifyDate>
        </CloudMssqlConfigGroup>
    </cloudMssqlConfigGroupList>
</getCloudMssqlConfigGroupListResponse>