SearchDetectionTarget

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Search for the desired item among the registered detection targets.

Request

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

Method	URI
POST	/servers

Request headers

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

Request body

The following describes the request body.

Field	Type	Required	Description
`pageIndex`	Integer	Optional	Page number
`pageSize`	Integer	Optional	Number of page outputs
`agentStatus`	Array	Optional	Agent status `enable` \| `disable` \| `notInstalled` \| `error` \| `activating` \| `down` `enable`: enabled `disable`: disabled `notInstalled`: not installed `error`: error `activating`: enabling `down`: agent down
`fileUploadPath`	String	Optional	File's upload directory
`webRootPath`	String	Optional	Web root directory
`ipAddress`	String	Optional	Server IP
`memo`	String	Optional	Notes
`serverGroupName`	String	Optional	Server group name
`serverImageName`	String	Optional	VM's server image name
`serverName`	String	Optional	VM's server name

Request example

The following is a sample request.

curl --location --request POST 'https://wbd.apigw.ntruss.com/api/v1/servers' \
--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' \
--data '{
    "agentStatus": [
        "enable"
    ]
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`success`	Boolean	-	Request handling status
`code`	Integer	-	Response code
`message`	String	-	Response message
`result`	Object	-	Response result
`content`	Array	-	Detection target list
`totalCount`	Integer	-	Number of response results
`pageSize`	Integer	-	Number of page outputs
`pageIndex`	Integer	-	Page number
`totalPages`	Integer	-	Total number of pages

`content`

The following describes content.

Field	Type	Required	Description
`instanceNo`	String	-	VM's instance number
`serverName`	String	-	VM's server name
`serverImageName`	String	-	VM's server image name
`serverStatus`	String	-	VM's current status
`serverType`	String	-	VM type
`serverEnvType`	String	-	Server environment type
`ipAddress`	String	-	Server IP
`agentStatus`	String	-	Agent status
`serverGroupId`	String	-	Server group ID
`serverGroupName`	String	-	Server group name
`platform`	String	-	Server platform `VPC` \| `CLASSIC`
`wasConfigList`	Array	-	WAS detection settings
`registeredTime`	Integer	-	Detection target registration date and time (timestamp)
`activationTime`	Integer	-	Agent activation date and time (timestamp)
`latestActivationTime`	Integer	-	Latest agent activation date and time (timestamp)
`latestDeactivationTime`	Integer	-	Latest agent deactivation date and time (timestamp)
`lastUpdatedTime`	Integer	-	Detection target's latest information modification date and time (timestamp)
`memberNo`	Integer	-	Member ID for VM usage
`memo`	String	-	Notes
`commandResult`	String	-	Detailed messages about the results of the command
`resultCode`	String	-	Result code for the command
`agentVersion`	String	-	Installed agent version
`agentEnable`	Boolean	-	Agent activation status `true` \| `false` `true`: enabled `false`: disabled
`agentStage`	String	-	Agent status
`chargeInstanceNo`	String	-	Instance number on which billing is based
`resultParam`	JSON	-	Details about the agent's execution/errors, etc.
`clusterName`	String	-	Cluster name of the pod where the agent is installed

`wasConfigList`

The following describes wasConfigList.

Field	Type	Required	Description
`wasType`	String	-	WAS type `jsp` \| `php`
`webRootPaths`	Array	-	Web root directory
`fileUploadPaths`	Array	-	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": 20,
        "pageIndex": 0,
        "totalPages": 1
    }
}

Was this article helpful?

What's Next

ActivateAgent

Table of contents

Request
Response