Set detailed inclusion for inspection results

Available in VPC

Set instances to include when viewing detailed inspection results for inspection items.

Note

If you do not set inspection result exclusion for an instance, the inspection results will be included and displayed by default without any separate settings for including detailed inspection results.

Request

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

Method	URI
POST	/api/v1/categories/{categoryCode}/checkitems/{itemCode}/result-detail/include

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 See Inspection item code.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`root`	Array	Required	`instanceKey` of queryable instances See Get details of inspection item inspection results.

Note

When entering instanceKey, see the following:

Enter in English, distinguishing uppercase and lowercase letters.
If there are invalid values, only the valid values are set, excluding the invalid values.

Request example

The request example is as follows:

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"
 ]'

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`	String	-	Settings result

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": "done"
}