get-data-box-summary-info

VPC環境で利用できます。

Data Boxのサマリー情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/data-box/get-data-box-summary-info

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`dataBoxFrameNo`	Integer	Required	Data Box Frame番号 get-data-box-frame-listを参照
`dataBoxNo`	Integer	Required	Data Box番号 get-data-box-listを参照

リクエスト例

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-summary-info?dataBoxFrameNo=83&dataBoxNo=381' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`dataBoxName`	String	-	Data Box名
`sslVpnCount`	Integer	-	SSL VPNを使用可能なアカウント数
`connectSslVpnUrl`	String	-	SSL VPNアクセス URL
`webBlockStatus`	Boolean	-	外部ネットワークをブロックするかどうか `true` \| `false` `true`: ブロック `false`: ブロックしない
`mountCount`	Integer	-	共用データの閲覧回数
`nasCount`	Integer	-	Data Boxストレージ数
`nasTotalSize`	Integer	-	Data Boxストレージの総容量(GB)
`nasTotalUseSize`	String	-	Data Boxストレージの総使用量(GB)
`createDate`	String	-	Data Boxの作成日時 YYYY-MM-DD HH:mm:ss形式
`statusCode`	String	-	Data Boxの状態コード `READY` \| `INIT` \| `USE` \| `ING` \| `RTN` \| `TERMT` `READY`: 申し込み中 `INIT`: 作成中 `USE`: 利用中 `ING`: 変更中 `RTN`: 返却中 `TERMT`: 返却完了
`exportApplyCount`	Integer	-	持ち出し審査リクエスト回数
`memo`	String	-	Data Boxに関する説明

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

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

レスポンス例

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

{
    "dataBoxName": "BOX#1",
    "sslVpnCount": 1,
    "connectSslVpnUrl": "https://sslvpn-kr-vpc-***.ncloud.com",
    "webBlockStatus": true,
    "mountCount": 0,
    "nasCount": 1,
    "nasTotalSize": 500,
    "nasTotalUseSize": "0",
    "createDate": "2025-03-25 11:20:11",
    "statusCode": "USE",
    "exportApplyCount": 0,
    "memo": "dbf001"
}