Cloud Advisor の概要

概要

Cloud Advisor は、ユーザーのリソースをチェックして、リソースが安定した状態で運営できるように支援する managementサービスです。

共通設定

API URL

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

リクエストヘッダ

• Cloud Advisor API をリクエストするためには、NAVERクラウドプラットフォームのアカウントおよびサブアカウントの認証キーの作成および認証値が必要です。
• Cloud Advisor API をリクエストする際に、ヘッダを通じて送信した NCPアカウントおよびサブアカウントのチェックリストに対する結果をレスポンスします。
• 認証キーの作成とリクエストヘッダの作成に関しては、Ncloud API Guide > API 呼び出しガイドをご参照ください。

レスポンスフォーマット

レスポンスフォーマットの例

• 成功例

{
  "result": "SUCCESS",
  "contents": [
    {
      "categoryCode": "SECURITY",
      "categoryName": "セキュリティ"
    },
    {
      "categoryCode": "COST",
      "categoryName": "費用&高可用性"
    }
  ]
}

• 失敗例

{
  "result": "FAIL"
  "error": {
    "errorCode": "API_CHECKITEM_NOT_FOUND",
    "message": "チェックリストが存在しません。(API_CHECKITEM_NOT_FOUND); フィールドエラー"
  }
}

レスポンスコード

• レスポンスコードには、 Cloud Advisor サービスだけのレスポンスコードとサービス共通エラーコードがあります。サービス共通エラーコードは、Ncloud API Guide > 3. 呼び出し > 失敗ガイドをご参照ください。
• Cloud Advisor サービスだけのレスポンスコード別メッセージと説明は次の通りです。

提供カテゴリおよびチェックリスト

現在 Cloud Advisor は、セキュリティおよび費用&高可用性カテゴリに限り、チェックリストを提供します。今後、より多くのカテゴリとチェックリストを継続的に追加しする予定です。Cloud Advisor API path に含まれる categoryCode および itemCode は、次の通りです。

{categoryCode}

{itemCode}