MENU
      getCloudDBConfigGroupList

        getCloudDBConfigGroupList


        기사 요약

        개요

        사용 가능한 CloudDB Config group 리스트를 조회합니다.
        현재 MSSQL에서만 사용 가능합니다.

        요청

        요청 헤더

        헤더명설명
        x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-apigw-api-keyAPIGW에서 발급받은 키 값, v2를 사용할 경우 api-key는 사용하지 않음
        x-ncp-apigw-api-key:{API Gateway API Key}
        x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeRequest body content type을 application/json으로 지정
        Content-Type: application/json

        요청 파라미터

        파라미터명필수 여부타입제약 사항설명
        dbKindCodeYStringMSSQLDB 유형 코드
        responseFormatTypeNStringresponse의 결과 format 설정
        • dbKindCode

          • 조회할 CloudDB의 종류 선택 해야 하지만, MySQL의 경우 추후 지원 예정이며
            현재는 MSSQL 만 선택 가능합니다.
        • responseFormatType

          • API 실행 결과를 응답 받을 format을 정합니다. xml과 json 중에서 선택 가능합니다.

        응답

        필드명타입설명비고
        requestIdString요청 ID 값
        returnMessageString응답 메시지
        totalRowsInteger응답 결과 row 수
        cloudDBConfigGroupList[]StringConfig Group 리스트 정보

        예시

        요청 예시

        curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBConfigGroupList?dbKindCode=MSSQL&responseFormatType=json"
        -H "accept: application/json"
        -H "Content-Type: application/x-www-form-urlencoded"
        -H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
        -H "x-ncp-apigw-timestamp: 1546398302273"
        -H "x-ncp-apigw-signature-v2: VXjaLhHB2CdowCrqDNYg7w7GR3TYxZzM2eIZ+i3IH0Q="
        
        https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBConfigGroupList?dbKindCode=MSSQL&responseFormatType=json
        HTTP

        요청 샘플

        • Cloud DB for MSSQL에서 사용 가능한 Config group 리스트 조회
        {
          "dbKindCode": "MSSQL",
          "responseFormatType": "json"
        }
        JSON

        응답 예시

        connection: keep-alive
        content-type: application/json;charset=UTF-8
        date: Mon, 24 Dec 2018 08:59:40 GMT
        server: nginx
        transfer-encoding: chunked
        x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2
        HTTP
        {
          "getCloudDBConfigGroupListResponse": {
            "returnCode": "0",
            "returnMessage": "success",
            "totalRows": 2,
            "cloudDBConfigGroupList": [
              {
                "configGroupNo": "0",
                "configGroupType": "system",
                "configGroupName": "mssql_2016_default"
              },
              {
                "configGroupNo": "91",
                "configGroupType": "user",
                "configGroupName": "test-group"
              }
            ]
          }
        }
        JSON

        오류 코드

        Cloud DB API 요청이 잘못되었거나, 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다

        오류 코드는 Cloud DB API의 '공통 오류 코드'와 'API Gateway 오류 코드' 두 가지입니다

        오류 코드응답 메시지설명
        200Ok
        500Server Error

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

        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.