Available in VPC
Set instances to exclude when viewing detailed inspection results for inspection items.
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/exclude |
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
|
itemCode |
String | Required | Inspection item code
|
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
instanceKeys |
Array | Required | instanceKey list of queryable instances |
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/exclude' \
--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
|
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"
}