Cloud Advisorの概要

Prev Next

VPC環境で利用できます。

Cloud Advisorは、NAVERプラットフォームで使用中のリソースをセキュリティ、コスト、高可用性の面から自動的にチェックする NAVERクラウドプラットフォームのサービスです。Cloud Advisorサービスでは、チェック機能関連の APIを RESTful形式で提供します。

Cloud Advisorの共通設定

Cloud Advisor APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

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

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
x-ncp-lang Optional レスポンスデータの多言語処理
  • ko-KR (デフォルト) | en-US | ja-JP | zh-CN
    • ko-kR: 韓国語
    • en-US: 英語
    • ja-JP: 日本語
    • zh-CN: 中国語(簡体字)
参考

APIの呼び出し時に次の内容をご確認ください。

  • チェックカテゴリ(categoryCode)に属しないチェック項目(itemCode)でリクエストすると404エラーが発生します。
  • サブアカウントで Cloud Advisor APIを呼び出す場合、サブアカウントに権限がある情報に対してのみレスポンス結果で返します。

レスポンス

共通レスポンス形式を説明します。

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功
呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

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

失敗
呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
  "result": "FAIL"
  "error": {
    "errorCode": "API_CHECKITEM_NOT_FOUND",
    "message": "チェック項目は存在しません。(API_CHECKITEM_NOT_FOUND); Fieldエラー"
  }
}

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
200 - OK リクエスト処理成功
400 - MISSING_REQUIRED_PARAM_ERROR 必須パラメータ欠落
400 - INVALID_PARAM_VALUE_ERROR 有効ではないパラメータ
401 - NO_AUTHENTICATION_INFORMATION リクエスト認証失敗
403 - SUBACCOUNT_PERMISSION_DENIED サブアカウントにこの機能の権限がない
404 - CATEGORY_NOT_FOUND 存在しないチェックカテゴリ
404 - CHECKITEM_NOT_FOUND 存在しないチェック項目
500 - API_UNKNOWN_SERVER_ERROR 不明なエラー
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

Cloud Advisorのチェック項目

Cloud Advisorサービスがチェックカテゴリごとに提供するチェック項目の説明は次の通りです。

チェックカテゴリ

チェックカテゴリの詳細は次の通りです。

チェックカテゴリコード 説明
SECURITY セキュリティカテゴリ
COST コスト&高可用性カテゴリ

チェック項目

チェック項目の詳細は次の通りです。

チェックカテゴリコード チェック項目コード チェック項目 説明
SECURITY SUB_ACCOUNT_ACCESSKEY Sub Accountアクセスキー管理 サブアカウントの Access Keyライフサイクルをチェック
SECURITY SUB_ACCOUNT_USE Sub Accountの使用 サブアカウントを使用するかどうかチェック
SECURITY SUB_ACCOUNT_PASSWORD Sub Accountパスワード管理 サブアカウントのパスワード使用日をチェック
SECURITY SUB_ACCOUNT_SECONDARY Sub Account2段階認証の設定有無 サブアカウント2段階認証設定の有無をチェック
SECURITY MAIN_ACCOUNT_ACCESSKEY Main Accountアクセスキー管理 メインアカウントの Access Key使用日をチェック
SECURITY MAIN_ACCOUNT_PASSWORD Main Accountパスワード管理 メインアカウントのパスワード使用日をチェック
SECURITY MAIN_ACCOUNT_SECONDARY Main Account2段階認証の設定有無 メインアカウント2段階認証の設定有無をチェック
SECURITY LOAD_BALANCER_LISTENER Load Balancerリスナーセキュリティ管理 VPC環境で作成したアプリケーションロードバランサ、ネットワークプロキシロードバランサに推奨する暗号化通信を行うリスナーが設定されているかチェック
SECURITY DNS_SPF Global DNSレコードの SPF MXをチェック Global DNSサービスにMXレコードが存在する場合、MXレコードに対応する SPFまたは TXTレコードが存在するかどうかをチェック
SECURITY DNS_TTL Global DNSレコードの TTLをチェック TTLが、推奨値の300秒より高い Global DNSレコードが存在しないかチェック
SECURITY DNS_AUTHORITY Global DNS Authority NSをチェック ドメインレジストラーまたは DNSが正しい Global DNSネームサーバを使用しているかチェック
SECURITY OBJECT_STORAGE_BUCKET Object Storageバケット権限 全バケットの ACLを確認して外部に公開するかどうかチェック
SECURITY CLOUD_DB_MYSQL_PORT Cloud DB MYSQLの基本 PORTをチェック Cloud DB for MySQLサービスで作成した DBサーバの基本ポート(3306)の使用有無をチェック
SECURITY ACG_PORT ACGポート管理 特定のポートを全 IPアドレス帯域に公開する(Any Open) ACGルールが存在するかどうかをチェック
SECURITY SUB_ACCOUNT_ROLE Sub Accountサービスの Role管理 Sub Accountサービスの Role使用日をチェック
COST CLOVA_OCR_UNUSED_RESOURCES Unused Resource - CLOVA OCR 直近7日間使用していない CLOVA OCRドメインの有無をチェック
COST CLOVA_DUBBING_UNUSED_RESOURCES Unused Resource - CLOVA Dubbing 直近7日間使用していない CLOVA Dubbingドメインの有無をチェック
COST IDLE_RESOURCE_VM Idle Resource - Server(VPC) 使用量が低くて使用していないと思われる Serverの有無をチェック
COST IDLE_RESOURCE_LB Idle Resource - Load Balancer(VPC) 使用量が低くて使用していないと思われる Load Balancerの有無をチェック
COST HIGH_UTILIZATION_VM High Utilization - Server(VPC) CPU使用量が高い状態で維持されている Serverの有無をチェック
COST HIGH_UTILIZATION_MYSQL High Utilization - Cloud DB for MySQL(VPC) CPU使用量が高い状態で維持されている Cloud DB for MySQLサービスの DBサーバの有無をチェック
COST HIGH_UTILIZATION_REDIS High Utilization - Cloud DB for Redis(VPC) CPU使用量が高い状態で維持されている Cloud DB for Redisサービスの DBサーバの有無をチェック
COST HIGH_UTILIZATION_MSSQL High Utilization - Cloud DB for MSSQL(VPC) CPU使用量が高い状態で維持されている Cloud DB for MSSQLサービスの DBサーバの有無をチェック
COST HIGH_UTILIZATION_MONGO High Utilization - Cloud DB for MongoDB(VPC) CPU使用量が高い状態で維持されている Cloud DB for MongoDBサービスの DBサーバの有無をチェック
COST OBJECT_STORAGE_MULTIPART Object Storage内の不完全な Multi-Part Object Bucket内の不完全な Multi-Part Objectの有無をチェック>

Cloud Advisor API

Cloud Advisorサービスで提供する APIの説明は次の通りです。

API 説明
チェックカテゴリの照会 Cloud Advisorサービスが提供するチェックカテゴリを照会
チェックカテゴリ状態の照会 チェックカテゴリの全チェック項目に対し、チェックリクエストが可能かどうかを照会
チェックカテゴリチェックのリクエスト チェックカテゴリの全チェック項目に対するチェックをリクエスト
チェックカテゴリチェック結果レベルの照会 チェックカテゴリの全チェック項目に対する通知レベル別チェック結果を要約して照会
チェックカテゴリチェック結果のサマリーの照会 チェックカテゴリの全チェック項目に対するチェック結果を要約して照会
チェックカテゴリチェック結果のダウンロード チェックカテゴリの全チェック項目に対するチェック結果をダウンロード
チェック項目の照会 Cloud Advisorサービスが提供するチェック項目を照会
チェック項目状態の照会 チェック項目に対してチェックリクエスト可能かどうか照会
チェック項目チェックのリクエスト チェック項目に対するチェックをリクエスト
チェック項目チェック結果のサマリーの照会 チェック項目に対するチェック結果のサマリーを照会
チェック項目チェック結果の詳細照会 チェック項目に対するインスタンスごとの詳細なチェック結果を照会
チェック項目チェック結果のダウンロード チェック項目に対するチェック結果をダウンロード
チェック結果詳細包含の設定 チェック項目チェック結果の詳細照会の際に含めるインスタンスを設定
チェック結果詳細除外の設定 チェック項目チェック結果の詳細照会の際に除外するインスタンスを設定
チェック結果のダウンロード 全チェックカテゴリのチェック項目に対するチェック結果をダウンロード

Cloud Advisor関連リソース

Cloud Advisor APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。