VPC環境で利用できます。
Boxの Connectサーバ情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/box/get-connect-info |
リクエストヘッダ
Datafence APIで共通して使用されるヘッダの詳細は、Datafenceのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
fenceId |
Integer | Required | Datafence番号 |
boxId |
Integer | Required | Box番号
|
instanceNo |
Integer | Required | Connectサーバインスタンス番号 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-connect-info?fenceId=26&boxId=74&instanceNo=*********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
storageList |
Array | - | Connectサーバストレージ情報 |
storageList
storageList
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
name |
String | - | Connectサーバにマウントされたブロックストレージまたは NASの名前 |
storagePath |
String | - | マウントのパス |
レスポンスステータスコード
Datafence APIで共通して使用されるレスポンスステータスコードの詳細は、Datafence APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"storageList": [
{
"name": "持ち出し申請用 NAS",
"storagePath": "C:\mount\1box1"
},
{
"name": "作業ファイル保存用ブロックストレージ",
"storagePath": "D:\"
}
]
}