createNasVolumeInstance

Prev Next

Classic環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /createNasVolumeInstance

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/server/v2/createNasVolumeInstance?volumeName=volume05&volumeSize=500&volumeAllotmentProtocolTypeCode=CIFS&accessControlRuleList.1.serverInstanceNo=23500000&accessControlRuleList.1.writeAccess=true&cifsUserName=user******&cifsUserPassword=*********&nasVolumeDescription=test&regionNo=1&zoneNo=3&isReturnProtection=false&isAsync=true' \
--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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、NasVolumeInstanceをご参照ください。

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

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

レスポンス例

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

{
    "createNasVolumeInstanceResponse": {
        "totalRows": 1,
        "nasVolumeInstanceList": [
            {
                "nasVolumeInstanceNo": "23500000",
                "nasVolumeInstanceStatus": {
                    "code": "INIT",
                    "codeName": "NAS INIT state"
                },
                "nasVolumeInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "NAS CREAT OP"
                },
                "nasVolumeInstanceStatusName": "creating",
                "createDate": "2024-04-08T11:40:50+0900",
                "nasVolumeDescription": "test",
                "mountInformation": "\\\\10.250.00.00\\n2768364_volume05",
                "volumeAllotmentProtocolType": {
                    "code": "CIFS",
                    "codeName": "CIFS"
                },
                "volumeName": "n2768364_volume05",
                "volumeTotalSize": 536870912000,
                "volumeSize": 536870912000,
                "snapshotVolumeConfigurationRatio": 0.0,
                "snapshotVolumeSize": 0,
                "isSnapshotConfiguration": false,
                "isEventConfiguration": false,
                "region": {
                    "regionNo": "1",
                    "regionCode": "KR",
                    "regionName": "Korea"
                },
                "zone": {
                    "zoneNo": "3",
                    "zoneName": "KR-2",
                    "zoneCode": "KR-2",
                    "zoneDescription": "坪村ゾーン",
                    "regionNo": "1"
                },
                "isReturnProtection": false,
                "nasVolumeInstanceCustomIpList": [],
                "nasVolumeServerInstanceList": []
            }
        ],
        "requestId": "",
        "returnCode": "0",
        "returnMessage": "success"
    }
}