VPC環境で利用できます。
検知対象のメモを追加したり、更新したりします。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PATCH | /servers/{server-id}/memo |
リクエストヘッダ
Webshell Behavior Detector APIで共通して使用されるヘッダの詳細は、Webshell Behavior Detectorの共通ヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
server-id |
Integer | Required | 検知対象サーバのインスタンス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
content |
String | Required | 変更後のメモ内容 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PATCH 'https://wbd.apigw.ntruss.com/api/v1/servers/25****97/memo' \
--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 '{
"content": "duplicated server"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
success |
Boolean | - | リクエスト処理の有無 |
code |
Integer | - | レスポンスコード |
message |
String | - | レスポンスメッセージ |
result |
Object | - | レスポンス結果 |
レスポンスステータスコード
Webshell Behavior Detector APIで共通して使用されるレスポンスステータスコードの詳細は、Webshell Behavior Detectorの共通レスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"success": true,
"code": 0,
"message": "success",
"result": {
"success": true,
"code": 0,
"message": "success",
"result": null
}
}