チェック項目状態の照会

VPC環境で利用できます。

チェック項目に対してチェックリクエスト可能かどうか照会します。

リクエスト

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

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

リクエストヘッダ

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/{itemCode}/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`	Object	-	チェック項目
`contents.itemCode`	String	-	チェック項目コード
`contents.timeToRefresh`	Long	-	次のチェック可能日時 Unix Timestamp形式
`contents.lastRequestTime`	Long	-	最終チェック日時 Unix Timestamp形式
`contents.status`	String	-	チェックの状態 `NONE` \| `ENQUEUED` \| `PROCESSING` \| `DONE` \| `FAIL` `NONE`: チェックリクエスト可能 `ENQUEUED`: チェック待機中 `PROCESSING`: チェック進行中 `DONE`: チェックリクエスト完了。次のリクエストまで待機 `FAIL`: チェックリクエスト失敗
`contents.refreshable`	String	-	チェックリクエスト可能かどうか `true` \| `false` `true`: 可能 `false`: 不可
`error`	Object	-	エラーコードとメッセージ `result`が`FAIL`の場合に表示
`error.errorCode`	String	-	エラーコード
`error.message`	String	-	エラーメッセージ

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

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

レスポンス例

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

{
    "result": "SUCCESS",
    "contents": {
        "itemCode": "OBJECT_STORAGE_BUCKET",
        "timeToRefresh": 0,
        "lastRequestTime": 0,
        "status": "NONE",
        "refreshable": true
    }
}