チェックカテゴリ状態の照会

VPC環境で利用できます。

チェックカテゴリの全チェック項目に対し、チェックリクエストが可能かどうかを照会します。

リクエスト

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

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

リクエストヘッダ

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/status' \
--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	-	チェック項目コード
`timeToRefresh`	Long	-	次のチェック可能日時 Unix Timestamp形式
`lastRequestTime`	Long	-	最終チェック日時 Unix Timestamp形式
`status`	String	-	チェックの状態 `NONE` \| `ENQUEUED` \| `PROCESSING` \| `DONE` \| `FAIL` `NONE`: チェックリクエスト可能 `ENQUEUED`: チェック待機中 `PROCESSING`: チェック進行中 `DONE`: チェックリクエスト完了。次のリクエストまで待機 `FAIL`: チェックリクエスト失敗
`refreshable`	String	-	チェックリクエスト可能かどうか `true` \| `false` `true`: 可能 `false`: 不可

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

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

レスポンス例

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

{
    "result": "SUCCESS",
    "contents": [
        {
            "itemCode": "CLOVA_OCR_UNUSED_RESOURCES",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "CLOVA_DUBBING_UNUSED_RESOURCES",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "IDLE_RESOURCE_VM",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "IDLE_RESOURCE_LB",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_VM",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MYSQL",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_REDIS",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MSSQL",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MONGO",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        },
        {
            "itemCode": "OBJECT_STORAGE_MULTIPART",
            "timeToRefresh": 0,
            "lastRequestTime": 0,
            "status": "NONE",
            "refreshable": true
        }
    ]
}