チェック項目の照会

VPC環境で利用できます。

Cloud Advisorサービスが提供するチェック項目を照会します。

リクエスト

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

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

リクエストヘッダ

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' \
--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	-	チェックカテゴリコード
`itemCode`	String	-	チェック項目コード
`itemName`	String	-	チェック項目名
`itemDescription`	String	-	チェック項目のサマリー情報
`itemDescriptionDetail`	String	-	チェック項目の詳細情報
`recommendation`	String	-	チェック項目に対する推奨対策
`checkLogicDescription`	String	-	チェック結果通知レベルの説明 GREEN \| YELLOW \| RED GREEN: 推奨設定に準拠している状態(正常) YELLOW: 対策が必要な状態(警告) RED: 迅速な対策が必要な状態(危険)
`checkResultType`	String	-	インスタンス別詳細チェック結果の提供タイプ `TABLE` \| `SAMPLE` `TABLE`: 提供 `SAMPLE`: 提供しない(チェック結果のサマリーのみ提供)
`tableHeaderInfo`	Array	-	インスタンスごとの詳細なチェック結果フィールド `tableHeaderInfo` \| `[]` `tableHeaderInfo`: `checkResultType`が`TABLE`の場合 `[]`: `checkResultType`が`SAMPLE`の場合

`tableHeaderInfo`

tableHeaderInfoの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`key`	String	-	チェック結果テーブル列の固有キー
`label`	String	-	チェック結果テーブル列の
`type`	String	-	チェック結果テーブル列の結果データタイプ `Status` \| `String` \| `Timestamp` \| `Number` \| `Integer` \| `Long` \| `Float`

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

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

レスポンス例

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "categoryCode": "SECURITY",
            "itemCode": "SUB_ACCOUNT_ACCESSKEY",
            "itemName": "Sub Accountアクセスキー管理",
            "itemDescription": "サブアカウントに追加された Access Keyのライフサイクルをチェックします。",
            "itemDescriptionDetail": "サブアカウント Access Key使用日をチェックします。セキュリティレベルを上げるには、Access Keyを交換することをお勧めします。",
            "recommendation": "サブアカウントが使用する Access Keyの使用日が90日を過ぎないように定期的に交換します。",
            "checkLogicDescription": "{{RED}}: サブアカウントが使用している Access Keyのうち、使用日が730日を超えた Keyが存在します。<br>\n{{YELLOW}}: サブアカウントが使用している Access Keyのうち、使用日が90日を超えた Keyが存在します。<br>\n{{GREEN}}: サブアカウントが使用しているすべての Access Keyの使用日は90日以内です。<br>\n* 使用中の Access Keyに対してのみチェックが行われます。",
            "checkResultType": "TABLE",
            "tableHeaderInfo": [
                {
                    "key": "status",
                    "label": "状態",
                    "type": "Status"
                },
                {
                    "key": "loginId",
                    "label": "ログイン ID",
                    "type": "String"
                },
                {
                    "key": "subAccountName",
                    "label": "サブアカウント名",
                    "type": "String"
                },
                {
                    "key": "accessKey",
                    "label": "AccessKey",
                    "type": "String"
                },
                {
                    "key": "accessKeyUseDays",
                    "label": "AccessKeyの使用日",
                    "type": "Integer"
                },
                {
                    "key": "accessKeyCreateDate",
                    "label": "AccessKeyの作成日",
                    "type": "Timestamp"
                }
            ]
        },
        ...
}