チェック結果詳細包含の設定

Prev Next

VPC環境で利用できます。

チェック項目チェック結果の詳細照会の際に含めるインスタンスを設定します。

参考

インスタンスにチェック結果除外設定をしていない場合、チェック結果詳細包含設定を別にしなくても、チェック結果にデフォルトで含まれて表示されます。

リクエスト

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

メソッド URI
POST /api/v1/categories/{categoryCode}/checkitems/{itemCode}/result-detail/include

リクエストヘッダ

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

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

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

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
root Array Required 照会可能なインスタンスのinstanceKey
参考

instanceKeyの入力時に次の内容をご確認ください。

  • 英字の大文字と小文字を区別して入力します。
  • 無効な値がある場合、その値は除いて有効な値に対してのみ設定します。

リクエスト例

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

curl --location --request POST 'https://cloud-advisor.apigw.ntruss.com/api/v1 /categories/{categoryCode}/checkitems/{itemCode}/result-detail/include' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '[
           "ncp_iam_BPA*************IMje",
           "ncp_iam_BPA*************4NH"
 ]'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result String - API処理結果
  • SUCCESS | FAIL
    • SUCCESS: 成功
    • FAIL: 失敗
contents String - 設定結果

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

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

レスポンス例

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

{
  "result": "SUCCESS",
  "contents": "done"
}