Get inspection category

Prev Next

Available in VPC

Get an inspection category provided by the Cloud Advisor service.

Request

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

Method URI
GET /api/v1/categories

Request headers

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

Request example

The request example is as follows:

curl --location --request GET 'https://cloud-advisor.apigw.ntruss.com/api/v1/categories' \
--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 Array - Inspection category list
error Object - Error code and message
  • Displayed if result is FAIL
error.errorCode String - Errors
error.message String - Error message

Inspection category

The following describes inspection categories.

Field Type Required Description
categoryCode String - Inspection category code
categoryName String - Inspection category code name

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": [
        {
            "categoryCode": "SECURITY",
            "categoryName": "Security"
        },
        {
            "categoryCode": "COST",
            "categoryName": "Expense and high utilization"
        }
    ]
}