createNasVolumeInstance
    • PDF

    createNasVolumeInstance

    • PDF

    Article Summary

    VPC環境で利用できます。

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

    リクエスト

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

    メソッドURI
    GET, POST/createNasVolumeInstance

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    regionCodeStringOptionalNASボリュームインスタンスが作成されるリージョンコード
    • getRegionListアクションを通じて確認(デフォルト: KR)
    zoneCodeStringOptionalNASボリュームインスタンスが作成されるゾーンコード
    • getZoneListアクションを通じて確認(デフォルト: KR-2)
    volumeAllotmentProtocolTypeCodeStringRequiredボリューム割り当てプロトコルタイプコード
    • NFS | CIFS
      • NFS: CentOS、Ubuntuなど Linuxサーバでマウント可能
      • CIFS: Windows Serverでマウント可能
    volumeSizeIntegerRequiredボリュームのサイズ
    • 500 ~ 10,000
    • 100GB単位で入力
    volumeNameStringOptionalNASボリューム名
    • 英数字のみ使用して3~20文字以内で入力
    • 入力しない場合、自動付与
    • 顧客の識別のために、入力した名前の先頭に「n会員番号_」が付く
    accessControlRuleList.N.serverInstanceNoStringConditionalアクセス制御に設定するサーバインスタンス番号
    • getServerInstanceListアクションを通じて確認
    • accessControlRuleList.N.writeAccess入力時、必須
    accessControlRuleList.N.writeAccessBooleanOptional書き込み権限を設定
    • true (デフォルト) | false
      • true: 設定
      • false: 設定しない
    cifsUserNameStringConditionalCIFSユーザー名
    • CIFSタイプのボリュームを初めて作成する場合、必須
    • 設定後は変更不可
    • 英数字を組み合わせて6~19文字以内で入力
    cifsUserPasswordStringConditionalCIFSユーザーパスワード
    • CIFSタイプのボリュームを初めて作成する場合、必須
    • 英数字、記号(!@^&*)を組み合わせて8~14以内で入力
    • CIFSユーザー名に類似するパスワードは使用不可
    isEncryptedVolumeBooleanOptionalNASボリューム暗号化を設定
    • NASボリュームごとに暗号化を適用
    • NASボリュームの初めての作成時にのみ適用可能
    • true | false (デフォルト)
      • true: 設定
      • false: 設定しない
    isReturnProtectionBooleanOptional返却保護を設定
    • true | false (デフォルト)
      • true: 設定
      • false: 設定しない
    nasVolumeDescriptionStringOptionalボリュームの説明(Byte)
    • 0~1,000
    isAsyncBooleanOptionalAsyncを設定
    • true | false (デフォルト)
      • true: 設定
      • false: 設定しない
    responseFormatTypeStringOptionalレスポンス結果の形式タイプ
    • 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"
        }
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.