Cloud Advisor overview

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/

Request headers

• 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

An example of a response format

• An example of success

{
  "result": "SUCCESS",
  "contents": [
    {
      "categoryCode": "SECURITY",
      "categoryName": "Security"
    },
    {
      "categoryCode": "COST",
      "categoryName": "Cost&high availability"
    }
  ]
}

• An example of failure

{
  "result": "FAIL"
  "error": {
    "errorCode": "API_CHECKITEM_NOT_FOUND",
    "message": "The checklist does not exist.(API_CHECKITEM_NOT_FOUND); Field error"
  }
}

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:

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}

{itemCode}