チェックカテゴリチェック結果レベルの照会

Prev Next

VPC環境で利用できます。

チェックカテゴリの全チェック項目に対する通知レベル別チェック結果を要約して照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/categories/{categoryCode}/dashboard

リクエストヘッダ

Cloud Advisor APIで共通して使用されるヘッダの詳細は、Cloud Advisorのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
categoryCode String Optional チェックカテゴリコード
  • SECURITY | COST
    • SECURITY: セキュリティカテゴリ
    • COST: コスト&高可用性カテゴリ

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/dashboard' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result String - API処理結果
  • SUCCESS | FAIL
    • SUCCESS: 成功
    • FAIL: 失敗
contents Array - チェックカテゴリリスト
error Object - エラーコードとメッセージ
  • resultがFAILの場合に表示
error.errorCode String - エラーコード
error.message String - エラーメッセージ

チェックカテゴリ

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

フィールド タイプ 必須の有無 説明
categoryCode String - チェックカテゴリコード
categoryName String - チェックカテゴリコード名
green String - チェックカテゴリでチェック結果通知レベルが GREENのチェック項目数
  • GREEN: 推奨設定に準拠している状態(正常)
yellow String - チェックカテゴリでチェック結果通知レベルが YELLOWのチェック項目数
  • YELLOW: 対策が必要な状態(警告)
red String - チェックカテゴリでチェック結果通知レベルが REDのチェック項目数
  • RED: 迅速な対策が必要な状態(危険)
参考

blueは、一時的な内部エラーにより表示される通知レベルです。サービスの使用に影響を与えないフィールドなので、APIレスポンス結果に表示される場合は、しばらくしてから再試行してください。

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

Cloud Advisor APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Advisorのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "categoryCode": "SECURITY",
            "categoryName": "セキュリティ",
            "green": 10,
            "yellow": 4,
            "red": 1,
            "blue": 0
        },
        {
            "categoryCode": "COST",
            "categoryName": "コスト&高可用性",
            "green": 10,
            "yellow": 0,
            "red": 0,
            "blue": 0
        }
    ]
}