Available in VPC
Change Data Box Frame infrastructure settings. This is an infrastructure change that takes some time, so it will be processed asynchronously.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/data-box-frame/modify-data-box-frame-admin-infra |
Request headers
For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
dataBoxFrameNo |
Integer | Required | Data Box Frame number |
memo |
String | Optional | Data Box Frame notes |
adminServerList |
Array | Conditional | Admin server list |
nasList |
Array | Conditional | NAS list |
adminServerList
The following describes adminServerList
.
Field | Type | Required | Description |
---|---|---|---|
actionType |
String | Required | Processing type
|
adminServerInstanceNo |
Integer | Conditional | Admin server instance number
|
prodSpecId |
Integer | Conditional | Server spec code
|
userPassword |
String | Required | Admin server access password
|
nasList
The following describes nasList
.
Field | Type | Required | Description |
---|---|---|---|
actionType |
String | Required | Processing type
|
count |
Integer | Conditional | NAS count
|
nasInstanceNo |
Integer | Conditional | NAS instance number
|
nasSize |
Integer | Conditional | NAS volume size (GB)
|
Request example
The request example is as follows:
curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/modify-data-box-frame-admin-infra' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"adminServerList": [
{
"actionType": "UPDATE",
"adminServerInstanceNo": ********,
"prodSpecId": 2001,
"userPassword": "********"
}
],
"dataBoxFrameNo": "83",
"memo": "about data box frame",
"nasList": [
{
"actionType": "CREATE",
"count": 1,
"nasInstanceNo": ********,
"nasSize": 600
}
]
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
returnMessage |
String | - | API processing result message |
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:
{
"returnMessage": "Modification of the Data Box Frame infrastructure has been requested."
}