Request inspection category inspection

Available in VPC

Request inspection of all inspection items in an inspection category.

Request

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

Method	URI
POST	/api/v1/categories/{categoryCode}/checkitems/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

Request example

The request example is as follows:

curl --location --request POST 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories/{categoryCode}/checkitems/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`	Array	-	Inspection item list
`error`	Object	-	Error code and message Displayed if `result` is `FAIL`
`error.errorCode`	String	-	Errors
`error.message`	String	-	Error message

Checklist

The following describes the inspection items.

Field	Type	Required	Description
`itemCode`	String	-	Inspection item code
`timeToRefresh`	Long	-	Next available inspection date and time Unix timestamp format
`lastRequestTime`	Long	-	Last inspection date and time Unix timestamp format
`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
`requestSuccess`	String	-	Inspection request success status `true` \| `false` `true`: succeeded `false`: failed

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": "CLOVA_OCR_UNUSED_RESOURCES",
            "timeToRefresh": 1744037730178,
            "lastRequestTime": 1743951330178,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "CLOVA_DUBBING_UNUSED_RESOURCES",
            "timeToRefresh": 1744037730363,
            "lastRequestTime": 1743951330363,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "IDLE_RESOURCE_VM",
            "timeToRefresh": 1744037730337,
            "lastRequestTime": 1743951330337,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "IDLE_RESOURCE_LB",
            "timeToRefresh": 1744037730259,
            "lastRequestTime": 1743951330259,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "HIGH_UTILIZATION_VM",
            "timeToRefresh": 1744037730298,
            "lastRequestTime": 1743951330298,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MYSQL",
            "timeToRefresh": 1744037730626,
            "lastRequestTime": 1743951330626,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "HIGH_UTILIZATION_REDIS",
            "timeToRefresh": 1744037730309,
            "lastRequestTime": 1743951330309,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "HIGH_UTILIZATION_MSSQL",
            "timeToRefresh": 1744037730229,
            "lastRequestTime": 1743951330229,
            "status": "DONE",
            "requestSuccess": true
        },
        {
            "itemCode": "HIGH_UTILIZATION_MONGO",
            "timeToRefresh": 1744037730280,
            "lastRequestTime": 1743951330280,
            "status": "DONE",
            "requestSuccess": false
        },
        {
            "itemCode": "OBJECT_STORAGE_MULTIPART",
            "timeToRefresh": 1743972930659,
            "lastRequestTime": 1743951330659,
            "status": "DONE",
            "requestSuccess": true
        }
    ]
}