Request inspection item inspection

Prev Next

Available in VPC

Request inspection of an inspection item.

Request

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

Method URI
POST /api/v1/categories/{categoryCode}/checkitems/{itemCode}/refresh

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 POST 'https://cloud-advisor.apigw.ntruss.com/api/v1 /categories/{categoryCode}/checkitems/{itemCode}/refresh' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
 }'

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.timeToRefresh Long - Next available inspection date and time
  • Unix timestamp format
contents.lastRequestTime Long - Last inspection date and time
  • Unix timestamp format
contents.status String - Inspection status
  • NONE | ENQUEUED | PROCESSING | DONE | FAIL
    • NONE: inspection request available
    • ENQUEUED: inspection pending
    • PROCESSING: inspection in progress
    • DONE: inspection request completed. Need to wait for the next request.
    • FAIL: inspection requested failed
contents.requestSuccess String - Inspection request success status
  • true | false
    • true: succeeded
    • false: unavailable
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",
        "timeToRefresh": 1743953713837,
        "lastRequestTime": 1743952813837,
        "status": "ENQUEUED",
        "requestSuccess": true
    }
}