get-data-box-frame-infra-list

Available in VPC

Get the list of Data Box Frame infrastructures.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v1/data-box-frame/get-data-box-frame-infra-list

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`dataBoxFrameNo`	Integer	Required	Data Box Frame number See get-data-box-frame-list.
`pageNo`	Integer	Optional	Page number 1-100 (default: 1)
`pageSize`	Integer	Optional	Page output count 1-100 (default: 10)

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`totalCount`	Integer	-	Number of response results
`content`	Array	-	Data Box Frame list
`usePseudonymInfo`	String	-	Whether to strengthen infrastructure management permissions `Y` \| `N`

`content`

The following describes content.

Field	Type	Required	Description
`infraType`	String	-	Infrastructure type `Server` \| `NAS`
`instanceName`	String	-	Infrastructure name
`privateIp`	String	-	Infrastructure private IP Displayed if `infraType`is `Server`
`publicIp`	String	-	Infrastructure public IP Displayed if `infraType`is `Server`
`osName`	String	-	Server operating system name Displayed `infraType` is `Server`
`specName`	String	-	Server or NAS specification name Capacity is displayed if `infraType` is `NAS`.
`userName`	String	-	Server access account name Display the mount path if `infraType` is `NAS`.
`prodSpecId`	String	-	Server spec code See Product spec code. Required if `infraType` is `Server`
`connectInfo`	String	-	Access information Admin server username
`useData`	String	-	Used data (GB) Displayed if `infraType` is `NAS`
`createDate`	String	-	Data Box Frame creation date and time YYYY-MM-DD HH:mm:ss format
`statusCode`	String	-	Data Box Frame status code `SET_READY` \| `SET_INIT` \| `SET_USE` \| `SET_ING` \| `SET_RTN` \| `SET_TERMT` `SET_READY`: requesting `SET_INIT`: creating `SET_USE`: in use `SET_ING`: changing `SET_RTN`: terminating `SET_TERMT`: termination completed
`statusName`	String	-	Data Box Frame status name `Request for creating` \| `Initial State` \| `Using` \| `Changing` \| `Returning` \| `Terminated` `Request for creating`: requesting `Initial State`: creating `Using`: in use `Changing`: changing `Returning`: terminating `Terminated`: termination completed
`instanceNo`	String	-	Infrastructure number
`contractInstanceNo`	String	-	Infrastructure instance number
`nasVolumeSize`	String	-	NAS volume size (GB) Displayed if `infraType` is `NAS`

Response status codes

For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.

Response example

The response example is as follows:

{
    "totalCount": 2,
    "content": [
        {
            "infraType": "Server",
            "instanceName": "admin-83-1",
            "privateIp": "***.***.***.***",
            "publicIp": "***.***.***.***",
            "osName": "Ubuntu",
            "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
            "prodSpecId": 2001,
            "userName": "root",
            "connectInfo": "root",
            "createDate": "2025-03-25 11:20:10",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceNo": "*********",
            "contractInstanceNo": "-",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "NAS",
            "instanceName": "pub83n1",
            "specName": "500",
            "userName": "root",
            "connectInfo": "/mnt/nasr/pub83n1",
            "useData": "0",
            "createDate": "2025-03-25 11:20:10",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceNo": "********",
            "contractInstanceNo": "-",
            "nasVolumeSize": "500"
        }
    ],
    "usePseudonymInfo": "N"
}