MENU
      Cloud Advisor 개요

        Cloud Advisor 개요


        기사 요약

        개요

        Cloud Advisor는 사용자의 리소스를 점검하여 리소스가 안정적인 상태에서 운영될 수 있도록 도와주는 management 서비스입니다.

        공통 설정

        API URL

        https://cloud-advisor.apigw.ntruss.com/api/v1/
        Plain text

        요청 헤더

        HeaderDescription
        x-ncp-langAPI 응답 값의 다국어 처리를 위한 값. (기본 값:ko-KR)
        ko-KR : 한국어
        en-US : English
        ja-JP : 日本語
        zh-CN : 中文(简体)
        x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(millisecond)로 나타낸 것
        API Gateway 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
        x-ncp-iam-access-key포털 또는 Sub Account에서 발급받은 Access Key ID
        x-ncp-apigw-signature-v2Access Key ID와 맵핑되는 SecretKey로 암호화한 서명
        HMAC 암호화 알고리즘은 HmacSHA256 사용
        • Cloud Advisor API 를 요청하기 위해서는 NAVER Cloud Platform 계정 및 서브 계정의 인증키 생성 및 인증 값이 필요합니다.
        • Cloud Advisor API 요청 시 헤더를 통해 전달한 NCP 계정 및 서브 계정의 점검 항목들에 대한 결과를 응답합니다.
        • 인증키 생성과 요청 헤더 생성 관련 내용은 Ncloud API Guide > API 호출 가이드를 참고해 주십시오.

        응답 포멧

        Field nameTypeRequiredDescription
        resultstring필수SUCCESS / FAIL
        contentsobject선택요청 성공 시 처리 결과 데이터
        errorobject선택요청 실패 시 오류 코드 및 메시지
        error.errorCodestring선택오류 코드
        error.messagestring선택오류 메시지

        응답 포맷 예

        • 성공 예시
        {
          "result": "SUCCESS",
          "contents": [
            {
              "categoryCode": "SECURITY",
              "categoryName": "보안"
            },
            {
              "categoryCode": "COST",
              "categoryName": "비용&고가용성"
            }
          ]
        }
        JSON
        • 실패 예시
        {
          "result": "FAIL"
          "error": {
            "errorCode": "API_CHECKITEM_NOT_FOUND",
            "message": "점검항목이 존재하지 않습니다.(API_CHECKITEM_NOT_FOUND); Field 오류"
          }
        }
        JSON

        응답 코드

        • 응답 코드에는 Cloud Advisor 서비스만의 응답 코드와 서비스 공통 오류 코드가 있습니다. 서비스 공통 오류 코드는 Ncloud API Guide > 3. 호출 > 실패 가이드를 참고해 주십시오.
        • Cloud Advisor 서비스만의 응답 코드별 메시지와 설명은 다음과 같습니다.
        HttpStatusCodeErrorCodeMessage
        200-요청 처리 성공
        400MISSING_REQUIRED_PARAM_ERROR필수 파라메터가 누락되었습니다.
        400INVALID_PARAM_VALUE_ERROR입력된 파라메터의 값이 유효하지 않습니다.
        401NO_AUTHENTICATION_INFORMATION서버에서 요청을 인증하지 못했습니다.
        403SUBACCOUNT_PERMISSION_DENIED서브 계정이 해당 기능에 대한 권한을 갖고 있지 않습니다.
        404CATEGORY_NOT_FOUND카테고리가 존재하지 않습니다.
        404CHECKITEM_NOT_FOUND점검항목이 존재하지 않습니다.
        500API_UNKNOWN_SERVER_ERROR알 수 없는 오류가 발생했습니다.

        제공 카테고리 및 점검 항목

        현재 Cloud Advisor는 보안 및 비용&고가용성 카테고리에 한하여 점검 항목을 제공합니다.
        추후 더 많은 카테고리와 점검 항목을 지속적으로 추가할 예정입니다.
        Cloud Advisor API path 에 포함되는 categoryCode 및 itemCode 는 아래와 같습니다.

        {categoryCode}

        categoryCode설명
        SECURITY보안 카테고리
        COST비용 & 고가용성 카테고리

        {itemCode}

        categoryCodeitemCode점검 항목점검 항목 설명
        SECURITYSUB_ACCOUNT_ACCESSKEYSub Account 액세스키 관리SubAccount에 추가된 Access Key의 수명을 점검합니다.
        SECURITYSUB_ACCOUNT_USESub Account 사용Sub Account 사용 여부를 검사합니다.
        SECURITYSUB_ACCOUNT_PASSWORDSub Account 비밀번호 관리Sub Account의 비밀번호 사용일을 점검합니다.
        SECURITYSUB_ACCOUNT_SECONDARYSub Account 2차인증 설정여부SubAccount에 2차 인증이 설정되어 있는지 점검합니다.
        SECURITYMAIN_ACCOUNT_ACCESSKEYMain Account 액세스키 관리메인 계정이 사용하고 있는 Access Key의 사용일을 점검합니다.
        SECURITYMAIN_ACCOUNT_PASSWORDMain Sccount 비밀번호 관리메인 계정의 비밀번호 사용일을 점검합니다.
        SECURITYMAIN_ACCOUNT_SECONDARYMain Account 2차인증 설정여부메인 계정에 2차 인증이 설정되어 있는지 점검합니다.
        SECURITYLOAD_BALANCER_LISTENERLoad Balancer 리스너 보안 관리VPC LoadBalancer (Application, Network Proxy)에 권장하는 암호화 통신을 하는 리스너가 포함되어 있는지 검사합니다.
        SECURITYOBJECT_STORAGE_BUCKETObject Storage 버킷 권한고객의 전체 버킷의 ACL을 확인하여, 외부에 공개된 경우 경고 합니다.
        SECURITYDNS_SPFGlobal DNS 레코드 SPF MX 점검MX 레코드에 대한 SPF, TXT 레코드가 존재하는지 확인합니다.
        SECURITYDNS_TTLGlobal DNS 레코드 TTL 점검도메인에 연결된 레코드 세트의 TTL이 권장 TTL보다 높은지 검사합니다.
        SECURITYDNS_AUTHORITYGlobal DNS Authority NS점검도메인 등록자 또는 DNS가 올바른 Global DNS 네임 서버를 사용하는지 검사합니다.
        SECURITYACG_PORTACG 포트 관리ACG 규칙 중 특정 포트에 대한 Any Open 규칙이 있는지 점검합니다.
        SECURITYCLOUD_DB_MYSQL_PORTCloud DB MYSQL 기본 PORT 점검Cloud DB for MySQL DB 서버 PORT를 점검합니다.
        COSTCLOVA_OCR_UNUSED_RESOURCESUnused Resource - CLOVA OCR생성 이후 사용되지 않는 CLOVA OCR 도메인을 점검합니다.
        COSTCLOVA_DUBBING_UNUSED_RESOURCESUnused Resource - CLOVA Dubbing생성 이후 사용되지 않는 CLOVA Dubbing 도메인을 점검합니다.
        COSTIDLE_RESOURCE_VMIdle Resource - Server사용량이 낮아 미 사용인 것으로 보이는 Server를 점검합니다.
        COSTIDLE_RESOURCE_LBIdle Resource - Load Balancer사용량이 낮아 미 사용인 것으로 보이는 Load Balancer를 점검합니다.
        COSTHIGH_UTILIZATION_VMHigh Utilization - Server사용량이 높은 상태로 유지되고 있는 Server를 점검합니다.
        COSTHIGH_UTILIZATION_MYSQLHigh Utilization - Cloud DB for MySQL사용량이 높은 상태로 유지되고 있는 Cloud DB for MySQL의 DB Server를 점검합니다.
        COSTHIGH_UTILIZATION_REDISHigh Utilization - Cloud DB for Redis사용량이 높은 상태로 유지되고 있는 Cloud DB for Redis의 DB Server를 점검합니다.
        COSTHIGH_UTILIZATION_MSSQLHigh Utilization - Cloud DB for MSSQL사용량이 높은 상태로 유지되고 있는 Cloud DB for MSSQL의 DB Server를 점검합니다.
        COSTHIGH_UTILIZATION_MONGOHigh Utilization - Cloud DB for MongoDB사용량이 높은 상태로 유지되고 있는 Cloud DB for MongoDB의 DB Server를 점검합니다.
        COSTOBJECT_STORAGE_MULTIPARTObject Storage 내 불완전한 Multi-Part ObjectBucket 내 불완전한 Multi-Part Object를 점검합니다.

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

        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.