Cloud Advisor の概要
    • PDF

    Cloud Advisor の概要

    • PDF

    記事の要約

    概要

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

    共通設定

    API URL

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

    リクエストヘッダ

    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 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": "費用&高可用性"
        }
      ]
    }
    
    • 失敗例
    {
      "result": "FAIL"
      "error": {
        "errorCode": "API_CHECKITEM_NOT_FOUND",
        "message": "チェックリストが存在しません。(API_CHECKITEM_NOT_FOUND); フィールドエラー"
      }
    }
    

    レスポンスコード

    • レスポンスコードには、 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 Accountパスワードの管理メインアカウントのパスワードの使用日をチェックします。
    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.