change-box-block-external-network

Prev Next

VPC環境で利用できます。

Boxの外部ネットワークをブロックするか許可するかを設定します。インフラの変更に一定時間がかかりますので、非同期で処理されます。

リクエスト

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

メソッド URI
POST /api/v1/box/change-box-block-external-network

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
fenceId Integer Required Datafence番号
boxId Integer Required Box番号
isBlock Boolean Required 外部ネットワークをブロックするかどうか
  • true | false
    • true: ブロック
    • false: 許可

リクエスト例

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

curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/box/change-box-block-external-network' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "fenceId": 26,
  "boxId": 74,
  "isBlock": true
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
message String - API処理結果メッセージ

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

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

レスポンス例

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

{
  "message": "Box network setting modification requested."
}