MENU
      GetDetectionTarget

        GetDetectionTarget


        Article summary

        Available in VPC

        Get status and information about the detection target server.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET/servers

        Request headers

        For headers common to all Webshell Behavior Detector APIs, see Common Webshell Behavior Detector headers.

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        pageIndexIntegerRequiredPage number
        pageSizeIntegerRequiredNumber of page outputs

        Request example

        The following is a sample request.

        curl --location --request GET 'https://wbd.apigw.ntruss.com/api/v1/servers?pageIndex=0&pageSize=1' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        --header 'X-NCP-USE_PLATFORM_TYPE: VPC'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        successBoolean-Request handling status
        codeInteger-Response code
        messageString-Response message
        resultObject-Response result
        contentArray-Detection target list
        totalCountInteger-Number of response results
        pageSizeInteger-Number of page outputs
        pageIndexInteger-Page number
        totalPagesInteger-Total number of pages

        content

        The following describes content.

        FieldTypeRequiredDescription
        instanceNoString-VM's instance number
        serverNameString-VM's server name
        serverImageNameString-VM's server image name
        serverStatusString-VM's current status
        serverTypeString-VM type
        serverEnvTypeString-Server environment type
        ipAddressString-Server IP
        agentStatusString-Agent status
        serverGroupIdString-Server group ID
        serverGroupNameString-Server group name
        platformString-Server platform
        • VPC | CLASSIC
        wasConfigListArray-WAS detection settings
        registeredTimeInteger-Detection target registration date and time (timestamp)
        activationTimeInteger-Agent activation date and time (timestamp)
        latestActivationTimeInteger-Latest agent activation date and time (timestamp)
        latestDeactivationTimeInteger-Latest agent deactivation date and time (timestamp)
        lastUpdatedTimeInteger-Detection target's latest information modification date and time (timestamp)
        memberNoInteger-Member ID for VM usage
        memoString-Notes
        commandResultString-Detailed messages about the results of the command
        resultCodeString-Result code for the command
        agentVersionString-Installed agent version
        agentEnableBoolean-Agent activation status
        • true | false
          • true: enabled
          • false: disabled
        agentStageString-Agent status
        chargeInstanceNoString-Instance number on which billing is based
        resultParamJSON-Details about the agent's execution/errors, etc.
        clusterNameString-Cluster name of the pod where the agent is installed

        wasConfigList

        The following describes wasConfigList.

        FieldTypeRequiredDescription
        wasTypeString-WAS type
        • jsp | php
        webRootPathsArray-Web root directory
        fileUploadPathsArray-File's upload directory

        Response status codes

        For response status codes common to all Webshell Behavior Detector APIs, see Common Webshell Behavior Detector response status codes.

        Response example

        The following is a sample example.

        {
            "success": true,
            "code": 0,
            "message": "success",
            "result": {
                "content": [
                    {
                        "instanceNo": "25****43",
                        "serverName": "tomcat",
                        "serverImageName": "CentOS 7.8 (64-bit) with Tomcat",
                        "serverStatus": "running",
                        "serverType": "VPCServer",
                        "serverEnvType": "HOST",
                        "ipAddress": "172.***.***.***",
                        "agentStatus": "enable",
                        "serverGroupId": null,
                        "serverGroupName": null,
                        "platform": "VPC",
                        "wasConfigList": [
                            {
                                "wasType": "jsp",
                                "webRootPaths": [
                                    "/opt/tomcat/webapps"
                                ],
                                "fileUploadPaths": [
                                    "/opt/tomcat/webapps/helloworld"
                                ]
                            }
                        ],
                        "registeredTime": 1722409425616,
                        "activationTime": 1722410006635,
                        "latestActivationTime": 1722475527004,
                        "latestDeactivationTime": null,
                        "lastUpdatedTime": 1722475536504,
                        "memberNo": 27***85,
                        "memo": "",
                        "commandResult": "OK",
                        "resultCode": 0,
                        "agentVersion": "1.0.5.030",
                        "agentEnable": true,
                        "agentStage": "RUNNING",
                        "chargeInstanceNo": "25****65",
                        "resultParam": null,
                        "clusterName": null
                    }
                ],
                "totalCount": 1,
                "pageSize": 10,
                "pageIndex": 0,
                "totalPages": 1
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.