チェック項目チェック結果のサマリーの照会

VPC環境で利用できます。

チェック項目に対するチェック結果を要約して照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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`	Object	-	チェック項目
`contents.itemCode`	String	-	チェック項目コード
`contents.status`	String	-	チェック結果通知レベル `GREEN` \| `YELLOW` \| `RED` `GREEN`: 推奨設定に準拠している状態(正常) `YELLOW`: 対策が必要な状態(警告) `RED`: 迅速な対策が必要な状態(危険)
`contents.summary`	String	-	チェック結果のサマリー
`contents.lastCheckTime`	String	-	最終チェック日時 Unix Timestamp形式
`error`	Object	-	エラーコードとメッセージ `result`が`FAIL`の場合に表示
`error.errorCode`	String	-	エラーコード
`error.message`	String	-	エラーメッセージ

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

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

レスポンス例

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

{
    "result": "SUCCESS",
    "contents": {
        "itemCode": "SUB_ACCOUNT_USE",
        "status": "GREEN",
        "summary": "このメインアカウントの下位にサブアカウントが1つ以上作成されています。",
        "lastCheckTime": 1743353842784
    }
}