Get inspection item inspection result summary

Prev Next

Available in VPC

Get a summary of the inspection results for an inspection item.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/categories/{categoryCode}/checkitems/{itemCode}/result-summary

Request headers

For information about the headers common to all Cloud Advisor APIs, see Cloud Advisor request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
categoryCode String Required Inspection category code
  • SECURITY | COST
    • SECURITY: security category
    • COST: expense and high availability category
itemCode String Required Inspection item code

Request example

The request example is as follows:

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/result-summary' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result String - API processing result
  • SUCCESS | FAIL
    • SUCCESS: succeeded
    • FAIL: failed
contents Object - Checklist
contents.itemCode String - Inspection item code
contents.status String - Inspection result notification level
  • GREEN | YELLOW | RED
    • GREEN: status of compliance with recommended settings (normal)
    • YELLOW: status requiring action (warning)
    • RED: status requiring immediate action (dangerous)
contents.summary String - Inspection result summary
contents.lastCheckTime String - Last inspection date and time
  • Unix timestamp format
error Object - Error code and message
  • Displayed if result is FAIL
error.errorCode String - Errors
error.message String - Error message

Response status codes

For response status codes common to all Cloud Advisor APIs, see Cloud Advisor response status codes.

Response example

The response example is as follows:

{
    "result": "SUCCESS",
    "contents": {
        "itemCode": "SUB_ACCOUNT_USE",
        "status": "GREEN",
        "summary": "One or more sub accounts have been created under the main account.",
        "lastCheckTime": 1743353842784
    }
}