createNasVolumeInstance

VPC環境で利用できます。

NASボリュームインスタンスを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET, POST	/createNasVolumeInstance

リクエストヘッダ

NAS APIで共通して使用されるヘッダの詳細は、NASの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	NASボリュームインスタンスが作成されるリージョンコード getRegionListアクションを通じて確認(デフォルト: `KR`)
`zoneCode`	String	Optional	NASボリュームインスタンスが作成されるゾーンコード getZoneListアクションを通じて確認(デフォルト: `KR-2`)
`volumeAllotmentProtocolTypeCode`	String	Required	ボリューム割り当てプロトコルタイプコード `NFS` \| `CIFS` `NFS`: CentOS、Ubuntuなど Linuxサーバでマウント可能 `CIFS`: Windows Serverでマウント可能
`volumeSize`	Integer	Required	ボリュームのサイズ 500 ~ 10,000 100GB単位で入力
`volumeName`	String	Optional	NASボリューム名英数字のみ使用して3~20文字以内で入力入力しない場合、自動付与顧客の識別のために、入力した名前の先頭に「n会員番号_」が付く
`accessControlRuleList.N.serverInstanceNo`	String	Conditional	アクセス制御に設定するサーバインスタンス番号 getServerInstanceListアクションを通じて確認 `accessControlRuleList.N.writeAccess`入力時、必須
`accessControlRuleList.N.writeAccess`	Boolean	Optional	書き込み権限を設定 `true` (デフォルト) \| `false` `true`: 設定 `false`: 設定しない
`cifsUserName`	String	Conditional	CIFSユーザー名 CIFSタイプのボリュームを初めて作成する場合、必須設定後は変更不可英数字を組み合わせて6~19文字以内で入力
`cifsUserPassword`	String	Conditional	CIFSユーザーパスワード CIFSタイプのボリュームを初めて作成する場合、必須英数字、記号(!@^&*)を組み合わせて8~14以内で入力 CIFSユーザー名に類似するパスワードは使用不可
`isEncryptedVolume`	Boolean	Optional	NASボリューム暗号化を設定 NASボリュームごとに暗号化を適用 NASボリュームの初めての作成時にのみ適用可能 `true` \| `false` (デフォルト) `true`: 設定 `false`: 設定しない
`isReturnProtection`	Boolean	Optional	返却保護を設定 `true` \| `false` (デフォルト) `true`: 設定 `false`: 設定しない
`nasVolumeDescription`	String	Optional	ボリュームの説明(Byte) 0~1,000
`isAsync`	Boolean	Optional	Asyncを設定 `true` \| `false` (デフォルト) `true`: 設定 `false`: 設定しない
`responseFormatType`	String	Optional	レスポンス結果の形式タイプ `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

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をご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
    }
}