チェック項目チェック結果の詳細照会

Prev Next

VPC環境で利用できます。

チェック項目に対するインスタンスごとの詳細なチェック結果を照会します。チェック項目のインスタンス別詳細チェック結果の提供有無は、チェック項目の照会で確認できます。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

チェックカテゴリ(categoryCode)に属しないチェック項目(itemCode)でリクエストすると404エラーが発生します。

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

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

フィールド タイプ 必須の有無 説明
display String Optional 照会対象のインスタンス
  • all | included (デフォルト)| excluded
    • all: 全インスタンス
    • included: 包含設定インスタンス
    • excluded: 除外設定インスタンス
page Integer Required ページ番号
  • 1~N
size Integer Required ページごとの項目数
  • 1~N
参考

包含インスタンスまたは除外インスタンスは、次の APIから設定できます。

リクエスト例

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

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/{itemCode}/result-detail?display=all&page=1&size=5' \
--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 - チェック項目コード
meta Object - ページ処理のためのメタデータ
meta.totalPage Integer - ページの総数
meta.currentPage Integer - 現在のページ番号
meta.size Integer - ページごとの項目数
data Array - チェック項目のインスタンスごとの詳細なチェック結果: ResultTableRow

ResultTableRow

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

フィールド タイプ 必須の有無 説明
memberNo Integer - アカウントの会員番号
instanceNo Integer - インスタンス番号
itemSid Integer - チェック項目 ID
  • 0~2147483647
instanceKey Integer - インスタンスの固有キー
status String - チェック結果通知レベル
  • GREEN | YELLOW | RED
    • GREEN: 推奨設定に準拠している状態(正常)
    • YELLOW: 対策が必要な状態(警告)
    • RED: 迅速な対策が必要な状態(危険)
参考

上記の表では、インスタンス別に共通して提供するフィールドを説明します。インスタンスごとに提供されるフィールド情報の詳細は、チェック結果の詳細照会レスポンス結果のtableHeaderInfoをご確認ください。

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

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

レスポンス例

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

{
  "result": "SUCCESS",
  "contents": {
    "itemCode": "SUB_ACCOUNT_USE",
    "meta": {
      "totalPage": 1,
      "currentPage": 1,
      "size": 5
    },
    "data": [
      {
        "memberNo": 2*****2,
        "instanceNo": 0,
        "itemSid": 2,
        "instanceKey": "2*****2",
        "status": "GREEN"
      }
    ]
  }
}