enableFlowLog

Prev Next

VPC環境で利用できます。

ネットワークインターフェースの Flow logを有効化します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/enableFlowLog
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

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

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
networkInterfaceNo String Required ネットワークインターフェース番号
collectActionTypeCode String Required 収集アクションタイプコード
  • ALLOW | DENY | ALL
    • ALLOW: 許可
    • DENY: 拒否
    • ALL: すべて
collectIntervalMinute Integer Optional 収集単位(分)
  • 5~15 (デフォルト: 15)
storageTypeCode String Optional 保存場所
  • OBJT: Object Storage (有効値)
storageBucketName String Required バケット名
storageBucketDirectoryName String Optional バケットのフォルダ名
  • 英字の小文字、数字、記号の「_」を組み合わせて3~100文字以内で入力 (デフォルト: VPC_FLOW_LOG)
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/enableFlowLog
?regionCode=KR
&networkInterfaceNo=70***6
&collectActionTypeCode=DENY
&collectIntervalMinute=15
&storageTypeCode=OBJT
&storageBucketName=mybucket
&storageBucketDirectoryName=myflowlog
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
enableFlowLogResponse Object - レスポンス結果
enableFlowLogResponse.requestId String - リクエスト ID
  • UUID形式
enableFlowLogResponse.returnCode String - レスポンスコード
enableFlowLogResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
  "enableFlowLogResponse": {
    "totalRows": 1,
    "flowLogConfigurationList": [
      {
        "networkInterfaceNo": "70***6",
        "collectActionType": {
          "code": "DENY",
          "codeName": "Deny"
        },
        "collectIntervalMinute": 15,
        "storageType": {
          "code": "OBJT",
          "codeName": "Object Storage"
        },
        "storageBucketName": "mybucket",
        "storageBucketDirectoryName": "myflowlog"
      }
    ],
    "requestId": "20e16cb0-****-****-****-68ab2a87b9cc",
    "returnCode": "0",
    "returnMessage": "success"
  }
}