VPC環境で利用できます。
Data Boxへのファイル持ち込み申請の詳細情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/v1/import/get-import-apply-detail |
リクエストヘッダ
Data Box Frame APIで共通して使用されるヘッダの詳細は、Data Box Frameのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
dataBoxFrameNo |
Integer | Required | Data Box Frame番号 |
dataBoxNo |
Integer | Required | Data Box番号 |
importApplyId |
Integer | Required | 持ち込み申請 ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/import/get-import-apply-detail?dataBoxFrameNo=83&dataBoxNo=381&importApplyId=878' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
totalCount |
Integer | - | レスポンス結果数 |
content |
Array | - | 持ち込み申請リスト |
content
content
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
importApplyId |
String | - | 持ち込み申請 ID |
dataBoxName |
String | - | Data Box名 |
dataBoxNo |
String | - | Data Box番号 |
targetNasName |
String | - | Target NAS名 |
sourceBucketName |
String | - | Sourceバケット名 |
sourceFileName |
String | - | 持ち込みファイル名 |
status |
String | - | 持ち込みの状態コード |
memo |
String | - | 持ち込み申請に関する説明 |
レスポンスステータスコード
Data Box Frame APIで共通して使用されるレスポンスステータスコードの詳細は、Data Box Frame APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"totalCount": 1,
"content": [
{
"importApplyId": "878",
"dataBoxName": "BOX#1",
"dataBoxNo": "381",
"targetNasName": "nasw381n1",
"sourceBucketName": "testddfdas",
"sourceFileName": "sample.xlsx",
"status": "SCSS",
"memo": "import001"
}
]
}