VPC環境で利用できます。
NASボリュームインスタンスを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | POST | /vnas/v2/createNasVolumeInstance |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
NAS (VPC) APIで共通して使用されるヘッダの詳細は、NAS (VPC)のリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
regionCode |
String | Optional | NASボリュームインスタンスが作成されるリージョンコード
|
zoneCode |
String | Optional | NASボリュームインスタンスが作成されるゾーンコード
|
volumeAllotmentProtocolTypeCode |
String | Required | ボリューム割り当てプロトコルタイプコード
|
volumeSize |
Integer | Required | ボリュームのサイズ
|
volumeName |
String | Optional | NASボリューム名
|
accessControlRuleList.N.serverInstanceNo |
String | Conditional | アクセス制御に設定するサーバインスタンス番号
|
accessControlRuleList.N.writeAccess |
Boolean | Optional | 書き込み権限を設定
|
cifsUserName |
String | Conditional | CIFSユーザー名
|
cifsUserPassword |
String | Conditional | CIFSユーザーパスワード
|
isEncryptedVolume |
Boolean | Optional | NASボリューム暗号化を設定
|
isReturnProtection |
Boolean | Optional | 返却保護を設定
|
nasVolumeDescription |
String | Optional | ボリュームの説明(Byte)
|
isAsync |
Boolean | Optional | Asyncを設定
|
responseFormatType |
String | Optional | レスポンス結果の形式タイプ
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/createNasVolumeInstance
?regionCode=KR
&zoneCode=KR-2
&volumeName=volume00
&volumeAllotmentProtocolTypeCode=CIFS
&volumeSize=500
&accessControlRuleList.1.serverInstanceNo=23430000
&accessControlRuleList.1.writeAccess=true
&cifsUserName=user******
&cifsUserPassword=************
&isEncryptedVolume=true
&isReturnProtection=true
&nasVolumeDescription=test
&isAsync=true
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、NasVolumeInstanceListをご参照ください。
レスポンスステータスコード
NAS (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、NAS (VPC)のレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"createNasVolumeInstanceResponse": {
"totalRows": 1,
"nasVolumeInstanceList": [
{
"nasVolumeInstanceNo": "23490000",
"nasVolumeInstanceStatus": {
"code": "INIT",
"codeName": "NAS INIT state"
},
"nasVolumeInstanceOperation": {
"code": "CREAT",
"codeName": "NAS CREAT OP"
},
"nasVolumeInstanceStatusName": "creating",
"createDate": "2024-04-08T09:04:28+0900",
"nasVolumeDescription": "test",
"mountInformation": "\\\\169.254.00.00\\n2768364_volume00",
"volumeAllotmentProtocolType": {
"code": "CIFS",
"codeName": "CIFS"
},
"volumeName": "n2768364_volume00",
"volumeTotalSize": 536870912000,
"volumeSize": 536870912000,
"snapshotVolumeConfigurationRatio": 0.0,
"snapshotVolumeSize": 0,
"isSnapshotConfiguration": false,
"isEventConfiguration": false,
"regionCode": "KR",
"zoneCode": "KR-2",
"nasVolumeServerInstanceNoList": [
"23430000"
],
"isEncryptedVolume": true,
"nasVolumeInstanceCustomIpList": [],
"isReturnProtection": true
}
],
"requestId": "",
"returnCode": "0",
"returnMessage": "success"
}
}