GetDetectionTarget
    • PDF

    GetDetectionTarget

    • PDF

    記事の要約

    VPC環境で利用できます。

    検知対象サーバの状態と情報を照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/servers

    リクエストヘッダ

    Webshell Behavior Detector APIで共通して使用されるヘッダの詳細は、Webshell Behavior Detectorの共通ヘッダをご参照ください。

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    pageIndexIntegerRequiredページ番号
    pageSizeIntegerRequiredページ表示数

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    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'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    successBoolean-リクエスト処理の有無
    codeInteger-レスポンスコード
    messageString-レスポンスメッセージ
    resultObject-レスポンス結果
    contentArray-検知対象リスト
    totalCountInteger-レスポンス結果数
    pageSizeInteger-ページ表示数
    pageIndexInteger-ページ番号
    totalPagesInteger-ページの総数

    content

    contentの説明は次の通りです。

    フィールドタイプ必須の有無説明
    instanceNoString-VMのインスタンス番号
    serverNameString-VMのサーバ名
    serverImageNameString-VMのサーバイメージ名
    serverStatusString-VMの現在の状態
    serverTypeString-VMタイプ
    serverEnvTypeString-サーバ環境タイプ
    ipAddressString-サーバの IPアドレス
    agentStatusString-エージェントの状態
    serverGroupIdString-サーバグループ ID
    serverGroupNameString-サーバグループ名
    platformString-サーバのプラットフォーム
    • VPC | CLASSIC
    wasConfigListArray-WAS検知設定
    registeredTimeInteger-検知対象の登録日時(Timestamp)
    activationTimeInteger-エージェントの有効化日時(Timestamp)
    latestActivationTimeInteger-エージェントの最終有効化日時(Timestamp)
    latestDeactivationTimeInteger-エージェントの最終無効化日時(Timestamp)
    lastUpdatedTimeInteger-検知対象の最終情報更新日時(Timestamp)
    memberNoInteger-VM使用会員番号
    memoString-メモ
    commandResultString-コマンド結果の詳細メッセージ
    resultCodeString-コマンドの結果コード
    agentVersionString-インストールされたエージェントのバージョン
    agentEnableBoolean-エージェント有効化の有無
    • true | false
      • true: 有効化
      • false: 無効化
    agentStageString-エージェントの状態
    chargeInstanceNoString-課金基準となるインスタンス番号
    resultParamJSON-エージェントの実行/エラーなどの詳細内容
    clusterNameString-エージェントがインストールされた Podのクラスタ名

    wasConfigList

    wasConfigListの説明は次の通りです。

    フィールドタイプ必須の有無説明
    wasTypeString-WASタイプ
    • jsp | php
    webRootPathsArray-ウェブルートディレクトリ
    fileUploadPathsArray-ファイルのアップロードディレクトリ

    レスポンスステータスコード

    Webshell Behavior Detector APIで共通して使用されるレスポンスステータスコードの詳細は、Webshell Behavior Detectorの共通レスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
        "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
        }
    }
    

    この記事は役に立ちましたか?

    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.