チェックカテゴリチェック結果のサマリーの照会

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET	/api/v1/categories/{categoryCode}/checkitems/result-summary

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/result-summary' \
--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	-	エラーメッセージ

チェック項目

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

フィールド	タイプ	必須の有無	説明
`itemCode`	String	-	チェック項目コード
`status`	String	-	チェック結果通知レベル `GREEN` \| `YELLOW` \| `RED` `GREEN`: 推奨設定に準拠している状態(正常) `YELLOW`: 対策が必要な状態(警告) `RED`: 迅速な対策が必要な状態(危険)
`summary`	String	-	チェック結果のサマリー
`lastCheckTime`	String	-	最終チェック日時 Unix Timestamp形式

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

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

レスポンス例

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "itemCode": "CLOVA_OCR_UNUSED_RESOURCES",
            "status": "GREEN",
            "summary": "<span>[KR] 全 CLOVA OCRドメインのうち0個が、過去7日間、認識リクエストがありません。<br/></span>",
            "lastCheckTime": 0
        },
        {
            "itemCode": "CLOVA_DUBBING_UNUSED_RESOURCES",
            "status": "GREEN",
            "summary": "全 CLOVA Dubbingドメインのうち0個が、過去7日間、使用量がないか、プロジェクトが存在しません。\n\n",
            "lastCheckTime": 0
        },
        {
            "itemCode": "IDLE_RESOURCE_VM",
            "status": "GREEN",
            "summary": "全 Serverの0個のうち0個が Idle状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "IDLE_RESOURCE_LB",
            "status": "GREEN",
            "summary": "全 Load Balancerの0個のうち0個が Idle状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_VM",
            "status": "GREEN",
            "summary": "全 Serverの0個のうち0個が High Utilization状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_MYSQL",
            "status": "GREEN",
            "summary": "全 DB Serverの0個のうち0個が High Utilization状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_REDIS",
            "status": "GREEN",
            "summary": "全 Redis Serverの0個のうち0個が High Utilization状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_MSSQL",
            "status": "GREEN",
            "summary": "全 DB Serverの0個のうち0個が High Utilization状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "HIGH_UTILIZATION_MONGO",
            "status": "GREEN",
            "summary": "全 DB Serverの0個のうち0個が High Utilization状態です。",
            "lastCheckTime": 0
        },
        {
            "itemCode": "OBJECT_STORAGE_MULTIPART",
            "status": "GREEN",
            "summary": "<span>[KR] 全 Bucketの0個のうち0個の Bucketで総0個、0の不完全な Multi-Part Objectが見つかりました。<br/></span>",
            "lastCheckTime": 0
        }
    ]
}