MENU
      Cloud Advisor overview

        Cloud Advisor overview


        Article summary

        Cloud Advisor is a management product that checks your resources and helps the resources operate at a stable status.

        Common settings

        API URL

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

        Request headers

        HeaderDescription
        x-ncp-langA value for multilingual processing of API response values. (Default value: ko-KR)
        ko-KR: 한국어
        en-US : English
        ja-JP : 日本語
        zh-CN : 中文(简体)
        x-ncp-apigw-timestampTime elapsed in milliseconds since January 1, 1970, 00:00:00 UTC
        If the time differs from that of the API Gateway server by 5 minutes or more, then the request is considered invalid
        x-ncp-iam-access-keyThis is the access key ID issued by the portal or Sub Account
        x-ncp-apigw-signature-v2Signature encrypted with the secret key mapped with the access key ID
        HmacSHA256 is used as the HMAC encryption algorithm
        • To request the Cloud Advisor API, you need to create an authentication key for the NAVER Cloud Platform account and sub account, and an authentication value.
        • When requesting the Cloud Advisor API, the results of the check items of the NCP account and sub account delivered through the header are replied to.
        • For information on creating authentication keys and request headers, see Ncloud API Guide > Call API guide.

        Response format

        Field nameTypeRequiredDescription
        resultstringRequirement statusSUCCESS / FAIL
        contentsobjectOptionalProcessing result data upon a successful request
        errorobjectOptionalErrors and messages on request failure
        error.errorCodestringOptionalErrors
        error.messagestringOptionalError message

        An example of a response format

        • An example of success
        {
          "result": "SUCCESS",
          "contents": [
            {
              "categoryCode": "SECURITY",
              "categoryName": "Security"
            },
            {
              "categoryCode": "COST",
              "categoryName": "Cost&high availability"
            }
          ]
        }
        JSON
        • An example of failure
        {
          "result": "FAIL"
          "error": {
            "errorCode": "API_CHECKITEM_NOT_FOUND",
            "message": "The checklist does not exist.(API_CHECKITEM_NOT_FOUND); Field error"
          }
        }
        JSON

        Response code

        • Response codes include response codes specific to the Cloud Advisor service and common service errors. For common service errors, see Ncloud API Guide > 3. Call > Failure guide.

        • The messages and descriptions for each response code specific to the Cloud Advisor service are as follows:

        HttpStatusCodeErrorCodeMessage
        200-Request handling successful
        400MISSING_REQUIRED_PARAM_ERRORThe required parameter is missing.
        400INVALID_PARAM_VALUE_ERRORThe value of the input parameter is invalid.
        401NO_AUTHENTICATION_INFORMATIONThe server failed to authenticate the request.
        403SUBACCOUNT_PERMISSION_DENIEDThe sub account does not have permission to access this feature.
        404CATEGORY_NOT_FOUNDThe category does not exist.
        404CHECKITEM_NOT_FOUNDThe checklist does not exist.
        500API_UNKNOWN_SERVER_ERRORUnknown error has occurred.

        Category offering and checklist

        Currently, Cloud Advisor only provides a checklist in the Security and Cost & High Availability category. More categories and checklists will continue to be added later. categoryCode and itemCode included in the Cloud Advisor API path are as follows:

        {categoryCode}

        categoryCodeDescription
        SECURITYSecurity category
        COSTCost & high availability category

        {itemCode}

        categoryCodeitemCodeChecklistDescription
        SECURITYSUB_ACCOUNT_ACCESSKEYSub account access key managementChecks the lifespan of the access key added to sub account.
        SECURITYSUB_ACCOUNT_USESub account useChecks whether the sub account is used.
        SECURITYSUB_ACCOUNT_PASSWORDSub account password managementChecks how many days the password for the sub account has been in use.
        SECURITYSUB_ACCOUNT_SECONDARYSub account 2-factor authentication statusChecks if the 2-factor authentication is configured on the sub account.
        SECURITYMAIN_ACCOUNT_ACCESSKEYMain account access key managementChecks how many days the access key for the main account has been in use.
        SECURITYMAIN_ACCOUNT_PASSWORDMain account password managementChecks how many days the password for the main account has been in use.
        SECURITYMAIN_ACCOUNT_SECONDARYMain account 2-factor authentication statusChecks whether or not the main account has 2-factor authentication settings.
        SECURITYLOAD_BALANCER_LISTENERLoad Balancer listener security managementChecks whether or not the VPC LoadBalancer (Application, Network Proxy) includes a listener that performs the recommended encrypted data transmission.
        SECURITYOBJECT_STORAGE_BUCKETObject Storage bucket authorizationChecks the ACL of the customer's entire bucket and displays a warning if it is open to other customers.
        SECURITYDNS_SPFGlobal DNS record SPF MX checkChecks if SPF and TXT records exist for an MX record.
        SECURITYDNS_TTLGlobal DNS record TTL checkChecks if the TTL of a record set connected to a domain is higher than the recommended TTL.
        SECURITYDNS_AUTHORITYGlobal DNS Authority NS checkChecks that a domain registrar or DNS is using the correct Global DNS name server.
        SECURITYACG_PORTACG port managementChecks if any of the ACG rules have an Any Open rule for a particular port.
        SECURITYCLOUD_DB_MYSQL_PORTCloud DB MYSQL default port checkChecks the cloud DB for MySQL DB server port.
        COSTCLOVA_OCR_UNUSED_RESOURCESUnused Resource - CLOVA OCRChecks for CLOVA OCR domains that are unused after creation.
        COSTCLOVA_DUBBING_UNUSED_RESOURCESUnused Resource - CLOVA DubbingChecks for CLOVA Dubbing domains that are unused after creation.
        COSTIDLE_RESOURCE_VMIdle Resource - ServerChecks for seemingly unused servers with low usage amounts.
        COSTIDLE_RESOURCE_LBIdle Resource - Load BalancerChecks for seemingly unused Load Balancers with low usage amounts.
        COSTHIGH_UTILIZATION_VMHigh Utilization - ServerChecks for servers maintaining high usage amounts.
        COSTHIGH_UTILIZATION_MYSQLHigh Utilization - Cloud DB for MySQLChecks for DB servers of Cloud DB for MySQL maintaining high usage amounts.
        COSTHIGH_UTILIZATION_REDISHigh Utilization - Cloud DB for RedisChecks for DB servers of Cloud DB for Redis maintaining high usage amounts.
        COSTHIGH_UTILIZATION_MSSQLHigh Utilization - Cloud DB for MSSQLChecks for DB servers of Cloud DB for MSSQL maintaining high usage amounts.
        COSTHIGH_UTILIZATION_MONGOHigh Utilization - Cloud DB for MongoDBChecks for DB servers of Cloud DB for MongoDB maintaining high usage amounts.
        COSTOBJECT_STORAGE_MULTIPARTIncomplete Multi-Part Object in Object StorageChecks for incomplete Multi-Part Object in the bucket.

        Was this article helpful?

        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.