API Guide - NHN Cloud User Guide

Storage > NAS > API Guide

To use the API, API endpoint and token are required. Refer to API usage preparations to prepare the information required to use the API.
NAS API uses the nasv1 type endpoint. Refer to the serviceCatalog in the token issuance response for the valid endpoint.

Type	Region	Endpoint
nasv1	Korea (Pangyo) Region Korea (Pyeongchon) Region	https://kr1-api-nas-infrastructure.nhncloudservice.com https://kr2-api-nas-infrastructure.nhncloudservice.com

API response may show the fields not specified by the guide. These fields are internally used by NHN Cloud, and not used because they are subject to change without prior notice.

Response Common Information

This section describes the common response information provided by the NAS API. All API responses convey the result of a request via a header object.

[Response Header]

Name	Type	Format	Description
header	Body	Object	Header Objects
header.isSuccessful	Body	Boolean	Whether the request was successful (`true` or `false`)
header.resultCode	Body	Integer	Result codes corresponding to HTTP status codes - `200`: Success - `201`: Resource creation successful - `202`: Request received successfully, but not yet processed - `400`: Requested with an invalid value - `401`: Permission, authentication, or token-related error - `404`: Requested resource not found - `405`: The requested URL does not support the specified HTTP method - `5XX`: The client's request is valid but the server failed to process it
header.resultMessage	Body	String	Messages about the results of request processing

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 200,
    "resultMessage": "Success"
  }
}

NAS Storage

List NAS Storage

Return the list of NAS storage.

GET  /v1/volumes
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
sizeGb	String	Query	-	NAS storage size
maxSizeGb	String	Query	-	NAS storage maximum size
minSizeGb	String	Query	-	NAS storage minimum size
name	String	Query	-	NAS storage name
nameContains	String	Query	-	Strings included in the NAS storage name
subnetId	String	Query	-	NAS storage with interfaces on a subnet
limit	String	Query	-	Number of resources to expose on a page
page	String	Query	-	Page to search
sort	String	Query	-	Name of the field to sort by Describe it in the form `{key}:{direction}`. Example: `name:asc`, `created_at:desc` Possible key values: `id`, `name`, `sizeGb`, `createdAt`, `updatedAt`

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
paging	Body	Object	About the page
paging.limit	Body	Integer	Number of resources exposed on a page
paging.page	Body	Integer	Current page number
paging.totalCount	Body	Integer	Total Count
volumes	Body	List	List of NAS storage objects
volumes.id	Body	String	NAS storage ID
volumes.name	Body	String	NAS storage name
volumes.status	Body	String	NAS storage status
volumes.description	Body	String	NAS storage description
volumes.sizeGb	Body	Integer	NAS storage size (GB)
volumes.projectId	Body	String	The project ID to which the NAS storage belongs
volumes.tenantId	Body	String	The tenant ID to which the NAS storage belongs
volumes.acl	Body	List	NAS storage ACL List
volumes.encryption	Body	Object	NAS storage encryption information
volumes.encryption.enabled	Body	Boolean	Whether to enable NAS storage encryption
volumes.encryption.keys	Body	List	NAS storage encryption keys information
volumes.interfaces	Body	List	List of NAS storage interface objects
volumes.interfaces.id	Body	String	Interface ID
volumes.interfaces.path	Body	String	Interface path
volumes.interfaces.status	Body	String	Interface status
volumes.interfaces.subnetId	Body	String	The subnet ID of the interface
volumes.interfaces.tenantId	Body	String	The tenant ID of the interface
volumes.mirrors	Body	List	NAS storage replication settings object list
volumes.mirrors.id	Body	String	Replication setting ID
volumes.mirrors.role	Body	String	Replication roles - `SOURCE`: Source storage - `DESTINATION`: Target storage
volumes.mirrors.status	Body	String	Replication setting status - `INITIALIZED`: Setup complete - `UPDATING`: Updating settings - `DELETING`: Deleting settings - `PENDING`: Creating settings
volumes.mirrors.direction	Body	String	Replication direction - `FORWARD`: Source storage -> Replica storage - `REVERSE`: Replica storage -> Source storage
volumes.mirrors.directionChangedAt	Body	String	When to change replication direction
volumes.mirrors.dstProjectId	Body	String	The project ID of the replication target storage
volumes.mirrors.dstRegion	Body	String	The region of the replication target storage
volumes.mirrors.dstTenantId	Body	String	The tenant ID of the replication target storage
volumes.mirrors.dstVolumeId	Body	String	The NAS storage ID of the replication target storage
volumes.mirrors.dstVolumeName	Body	String	The NAS storage name of the replication target storage
volumes.mirrors.srcProjectId	Body	String	The project ID of the source storage
volumes.mirrors.srcRegion	Body	String	The region of the source storage
volumes.mirrors.srcTenantId	Body	String	The tenant ID of the source storage
volumes.mirrors.srcVolumeId	Body	String	The NAS storage ID of the source storage
volumes.mirrors.srcVolumeName	Body	String	Source storage NAS storage name
volumes.mirrors.createdAt	Body	String	Replication creation time
volumes.mountProtocol	Body	Object	NAS storage mount protocols
volumes.mountProtocol.cifsAuthIds	Body	List	NAS Storage CIFS Authentication ID List
volumes.mountProtocol.protocol	Body	String	NAS storage mount protocols
volumes.snapshotPolicy	Body	Object	NAS storage volume snapshot settings object
volumes.snapshotPolicy.maxScheduledCount	Body	Integer	The maximum number of snapshots that can be saved
volumes.snapshotPolicy.reservePercent	Body	Integer	Snapshot capacity ratio
volumes.snapshotPolicy.schedule	Body	Object	Snapshot auto-create objects
volumes.snapshotPolicy.schedule.time	Body	String	Snapshot auto-create time
volumes.snapshotPolicy.schedule.timeOffset	Body	String	Time zone for snapshot auto-create
volumes.snapshotPolicy.schedule.weekdays	Body	List	Days of the week that snapshots are automatically created An empty list means every day, and the days of the week are specified as a list of numbers from 0 (Sunday) to 6 (Saturday).
volumes.createdAt	Body	String	NAS storage created time
volumes.updatedAt	Body	String	NAS storage changed time

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 200,
    "resultMessage": "Success"
  },
  "paging": {
    "limit": 50,
    "page": 1,
    "totalCount": 1
  },
  "volumes": [
    {
      "acl": [
        "10.0.1.0/24"
      ],
      "createdAt": "2025-04-01T06:44:25+00:00",
      "description": "NAS for Testing",
      "encryption": {
        "enabled": false
      },
      "id": "fc8b111a-32b7-45d3-b123-ff3ecaaf768a",
      "interfaces": [
        {
          "id": "9a8ec90f-cc27-4649-9bda-a1f0b193a402",
          "path": "10.0.1.7:/TEST-NAS-1",
          "status": "ACTIVE",
          "subnetId": "cb779d62-72ef-43b6-b368-3fe28dcd812b",
          "tenantId": "3b6179e5fa6b499386b827357c4cb8c4"
        }
      ],
      "mirrors": [
        {
          "createdAt":"2025-04-01T06:45:45+00:00",
          "direction": "FORWARD",
          "directionChangedAt": null,
          "dstProjectId": "K3y0CgOy",
          "dstRegion": "KR2",
          "dstTenantId": "3b6179e5fa6b499386b827357c4cb8c4",
          "dstVolumeId": "e09281d2-0b1c-48a9-8a01-0098aa59f624",
          "dstVolumeName": "TEST-NAS-MIRROR-1",
          "id": "8116892c-7306-48be-9e3d-143311b2254c",
          "role": "SOURCE",
          "srcProjectId": "K3y0CgOy",
          "srcRegion": "KR1",
          "srcTenantId": "3b6179e5fa6b499386b827357c4cb8c4",
          "srcVolumeId": "fc8b111a-32b7-45d3-b123-ff3ecaaf768a",
          "srcVolumeName": "TEST-NAS-1",
          "status": "PENDING"
        }
      ],
      "mountProtocol": {
        "protocol": "cifs",
        "cifsAuthIds": [
          "cifs-test-id"
        ]
      },
      "name": "TEST-NAS-1",
      "projectId": "K3y0CgOy",
      "sizeGb": 300,
      "snapshotPolicy": {
        "maxScheduledCount": 1,
        "reservePercent": 5,
        "schedule": {
          "time": "00:00",
          "timeOffset": "+09:00",
          "weekdays": [
            1,
            3,
            5
          ]
        }
      },
      "stationId": null,
      "status": "ACTIVE",
      "tenantId": "3b6179e5fa6b499386b827357c4cb8c4",
      "updatedAt": "2025-04-01T06:47:13+00:00"
    }
  ]
}

Create NAS storage

Create a new NAS storage.

[Note] Using the CIFS protocol To use the CIFS protocol, you must create CIFS credentials. Credentials are managed on a per-project basis, and you must register CIFS credentials to access each CIFS storage. You can create CIFS credentials through the Storage > NAS > Manage CIFS Credentials of the console.

[Note] Setting up encryption key storage NAS encrypted storage stores symmetric keys used for encryption in a keystore managed by the NHN Cloud Secure Key Manager service. To create encrypted storage,you must first create a keystorein the Secure Key Manager service. After creating the keystore, check its ID and enter it in the encryption keystore settings. You can enter the keystore ID from the Storage > NAS > Encryption keystore settings in the console. When you create encrypted storage, the symmetric key is stored in the specified keystore. The symmetric key stored by the NAS service in the keystore cannot be deleted while the encrypted storage is in use. When the encrypted storage is deleted, the corresponding symmetric key is also deleted. If you change the keystore ID, symmetric keys for newly created encrypted storage will be stored in the new keystore. Symmetric keys already stored in the previous keystore are retained.

POST  /v1/volumes
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume	Body	Object	O	NAS storage creation request object
volume.acl	Body	List	-	List of ACL IDs to set when creating NAS storage You can enter it in IP or CIDR format.
volume.description	Body	String	-	NAS storage description
volume.encryption	Body	Object	-	Encryption settings object when creating NAS storage
volume.encryption.enabled	Body	Boolean	-	Whether to enable encryption settings After the encryption keystore is set up, setting its field to `true`enables encryption.
volume.interfaces	Body	List	-	List of interfaces to access NAS storage
volume.interfaces.subnetId	Body	String	-	The subnet ID of the NAS storage interface
volume.mountProtocol	Body	Object	-	Protocol settings object when creating NAS storage
volume.mountProtocol.cifsAuthIds	Body	List	-	List of CIFS Authentication IDs No input required for NFS protocol selection
volume.mountProtocol.protocol	Body	String	O	Specifying protocols when mounting NAS storage You can choose between `NFS` and `CIFS`.
volume.name	Body	String	O	NAS storage name
volume.sizeGb	Body	Integer	O	NAS storage size (GB) NAS storage can be set from a minimum of 300GB to a maximum of 10,000GB, in 100GB increments.
volume.snapshotPolicy	Body	Object	-	NAS storage volume snapshot settings object
volume.snapshotPolicy.maxScheduledCount	Body	Integer	-	The maximum number of snapshots that can be saved You can set a maximum of 30, and the first automatically created snapshot will be deleted when the maximum number of saves is reached.
volume.snapshotPolicy.reservePercent	Body	Integer	-	Snapshot capacity ratio
volume.snapshotPolicy.schedule	Body	Object	-	Snapshot auto-create objects If `null`, snapshot auto-creation will not be configured.
volume.snapshotPolicy.schedule.time	Body	String	-	Snapshot auto-create time
volume.snapshotPolicy.schedule.timeOffset	Body	String	-	Time zone for snapshot auto-create
volume.snapshotPolicy.schedule.weekdays	Body	List	-	Days of the week that snapshots are automatically created. An empty list means every day, and the days of the week are specified as a list of numbers from 0 (Sunday) to 6 (Saturday).

Request Example

{
  "volume": {
    "acl": [
      "10.0.1.0/24"
    ],
    "description": "NAS for Testing",
    "encryption": {
      "enabled": true
    },
    "interfaces": [
      {
        "subnetId": "cb779d62-72ef-43b6-b368-3fe28dcd812b"
      }
    ],
    "mountProtocol": {
      "protocol": "nfs"
    },
    "name": "TEST-NAS-1",
    "sizeGb": 300,
    "snapshotPolicy": {
      "maxScheduledCount": 20,
      "reservePercent": 10,
      "schedule": {
        "time": "03:00",
        "timeOffset": "+09:00",
        "weekdays": [
          1,
          3,
          5
        ]
      }
    }
  }
}

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
volume	Body	Object	NAS storage objects
volume.id	Body	String	NAS storage ID
volume.name	Body	String	NAS storage name
volume.status	Body	String	NAS storage status
volume.description	Body	String	NAS storage description
volume.sizeGb	Body	Integer	NAS storage size (GB)
volume.projectId	Body	String	The project ID to which the NAS storage belongs
volume.tenantId	Body	String	The tenant ID to which the NAS storage belongs
volume.acl	Body	List	NAS storage ACL List
volume.encryption	Body	Object	NAS storage encryption information
volume.encryption.enabled	Body	Boolean	Whether to enable NAS storage encryption
volume.encryption.keys	Body	List	NAS storage encryption keys information
volume.interfaces	Body	List	List of NAS storage interface objects
volume.interfaces.id	Body	String	Interface ID
volume.interfaces.path	Body	String	Interface path
volume.interfaces.status	Body	String	Interface status
volume.interfaces.subnetId	Body	String	The subnet ID of the interface
volume.interfaces.tenantId	Body	String	The tenant ID of the interface
volume.mirrors	Body	List	NAS storage replication settings object list
volume.mirrors.id	Body	String	Replication setting ID
volume.mirrors.role	Body	String	Replication roles - `SOURCE`: Source storage - `DESTINATION`: Target storage
volume.mirrors.status	Body	String	Replication setting status - `INITIALIZED`: Setup complete - `UPDATING`: Updating settings - `DELETING`: Deleting settings - `PENDING`: Creating settings
volume.mirrors.direction	Body	String	Replication direction - `FORWARD`: Original storage -> Replica storage - `REVERSE`: Replica storage -> Original storage
volume.mirrors.directionChangedAt	Body	String	When to change replication direction
volume.mirrors.dstProjectId	Body	String	The project ID of the replication target storage
volume.mirrors.dstRegion	Body	String	The region of the replication target storage
volume.mirrors.dstTenantId	Body	String	The tenant ID of the replication target storage
volume.mirrors.dstVolumeId	Body	String	The NAS storage ID of the replication target storage
volume.mirrors.dstVolumeName	Body	String	The NAS storage name of the replication target storage
volume.mirrors.srcProjectId	Body	String	The project ID of the source storage
volume.mirrors.srcRegion	Body	String	The region of the source storage
volume.mirrors.srcTenantId	Body	String	The tenant ID of the source storage
volume.mirrors.srcVolumeId	Body	String	The NAS storage ID of the source storage
volume.mirrors.srcVolumeName	Body	String	Source storage NAS storage name
volume.mirrors.createdAt	Body	String	Replication creation time
volume.mountProtocol	Body	Object	NAS storage mount protocols
volume.mountProtocol.cifsAuthIds	Body	List	NAS Storage CIFS Authentication ID List
volume.mountProtocol.protocol	Body	String	NAS storage mount protocols
volume.snapshotPolicy	Body	Object	NAS storage volume snapshot settings object
volume.snapshotPolicy.maxScheduledCount	Body	Integer	The maximum number of snapshots that can be saved
volume.snapshotPolicy.reservePercent	Body	Integer	Snapshot capacity ratio
volume.snapshotPolicy.schedule	Body	Object	Snapshot auto-create objects
volume.snapshotPolicy.schedule.time	Body	String	Snapshot auto-create time
volume.snapshotPolicy.schedule.timeOffset	Body	String	Time zone for snapshot auto-create
volume.snapshotPolicy.schedule.weekdays	Body	List	Days of the week that snapshots are automatically created An empty list means every day, and the days of the week are specified as a list of numbers from 0 (Sunday) to 6 (Saturday).
volume.createdAt	Body	String	NAS storage created time
volume.updatedAt	Body	String	NAS storage changed time

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 201,
    "resultMessage": "Created"
  },
  "volume": {
    "acl": [
      "10.0.1.0/24"
    ],
    "createdAt": "2025-04-01T06:44:25+00:00",
    "description": "NAS for Testing",
    "encryption": {
      "enabled": false
    },
    "id": "fc8b111a-32b7-45d3-b123-ff3ecaaf768a",
    "interfaces": [
      {
        "id": "9a8ec90f-cc27-4649-9bda-a1f0b193a402",
        "path": "10.0.1.7:/TEST-NAS-1",
        "status": "ACTIVE",
        "subnetId": "cb779d62-72ef-43b6-b368-3fe28dcd812b",
        "tenantId": "3b6179e5fa6b499386b827357c4cb8c4"
      }
    ],
    "mirrors": [
      {
        "createdAt":"2025-04-01T06:45:45+00:00",
        "direction": "FORWARD",
        "directionChangedAt": null,
        "dstProjectId": "K3y0CgOy",
        "dstRegion": "KR2",
        "dstTenantId": "3b6179e5fa6b499386b827357c4cb8c4",
        "dstVolumeId": "e09281d2-0b1c-48a9-8a01-0098aa59f624",
        "dstVolumeName": "TEST-NAS-MIRROR-1",
        "id": "8116892c-7306-48be-9e3d-143311b2254c",
        "role": "SOURCE",
        "srcProjectId": "K3y0CgOy",
        "srcRegion": "KR1",
        "srcTenantId": "3b6179e5fa6b499386b827357c4cb8c4",
        "srcVolumeId": "fc8b111a-32b7-45d3-b123-ff3ecaaf768a",
        "srcVolumeName": "TEST-NAS-1",
        "status": "PENDING"
      }
    ],
    "mountProtocol": {
      "protocol": "cifs",
      "cifsAuthIds": [
        "cifs-test-id"
      ]
    },
    "name": "TEST-NAS-1",
    "projectId": "K3y0CgOy",
    "sizeGb": 300,
    "snapshotPolicy": {
      "maxScheduledCount": 1,
      "reservePercent": 5,
      "schedule": {
        "time": "00:00",
        "timeOffset": "+09:00",
        "weekdays": [
          1,
          3,
          5
        ]
      }
    },
    "stationId": null,
    "status": "ACTIVE",
    "tenantId": "3b6179e5fa6b499386b827357c4cb8c4",
    "updatedAt": "2025-04-01T06:47:13+00:00"
  }
}

Delete NAS storage

Deletes the specified NAS storage.

DELETE  /v1/volumes/{volume_id}
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID to delete

Response

The response body does not contain any content other than header fields.

View NAS storage

Returns details about the specified NAS storage.

GET   /v1/volumes/{volume_id}
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID to query

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
volume	Body	Object	NAS storage objects
volume.id	Body	String	NAS storage ID
volume.name	Body	String	NAS storage name
volume.status	Body	String	NAS storage status
volume.description	Body	String	NAS storage description
volume.sizeGb	Body	Integer	NAS storage size (GB)
volume.projectId	Body	String	The project ID to which the NAS storage belongs
volume.tenantId	Body	String	The tenant ID to which the NAS storage belongs
volume.acl	Body	List	NAS storage ACL List
volume.encryption	Body	Object	NAS storage encryption information
volume.encryption.enabled	Body	Boolean	Whether to enable NAS storage encryption
volume.encryption.keys	Body	List	NAS storage encryption keys information
volume.interfaces	Body	List	List of NAS storage interface objects
volume.interfaces.id	Body	String	Interface ID
volume.interfaces.path	Body	String	Interface path
volume.interfaces.status	Body	String	Interface status
volume.interfaces.subnetId	Body	String	The subnet ID of the interface
volume.interfaces.tenantId	Body	String	The tenant ID of the interface
volume.mirrors	Body	List	NAS storage replication settings object list
volume.mirrors.id	Body	String	Replication setting ID
volume.mirrors.role	Body	String	Replication roles - `SOURCE`: Source storage - `DESTINATION`: Target storage
volume.mirrors.status	Body	String	Replication setting status - `INITIALIZED`: Setup complete - `UPDATING`: Updating settings - `DELETING`: Deleting settings - `PENDING`: Creating settings
volume.mirrors.direction	Body	String	Replication direction - `FORWARD`: Original storage -> Replica storage - `REVERSE`: Replica storage -> Original storage
volume.mirrors.directionChangedAt	Body	String	When to change replication direction
volume.mirrors.dstProjectId	Body	String	The project ID of the replication target storage
volume.mirrors.dstRegion	Body	String	The region of the replication target storage
volume.mirrors.dstTenantId	Body	String	The tenant ID of the replication target storage
volume.mirrors.dstVolumeId	Body	String	The NAS storage ID of the replication target storage
volume.mirrors.dstVolumeName	Body	String	The NAS storage name of the replication target storage
volume.mirrors.srcProjectId	Body	String	The project ID of the source storage
volume.mirrors.srcRegion	Body	String	The region of the source storage
volume.mirrors.srcTenantId	Body	String	The tenant ID of the source storage
volume.mirrors.srcVolumeId	Body	String	The NAS storage ID of the source storage
volume.mirrors.srcVolumeName	Body	String	Source storage NAS storage name
volume.mirrors.createdAt	Body	String	Replication creation time
volume.mountProtocol	Body	Object	NAS storage mount protocols
volume.mountProtocol.cifsAuthIds	Body	List	NAS Storage CIFS Authentication ID List
volume.mountProtocol.protocol	Body	String	NAS storage mount protocols
volume.snapshotPolicy	Body	Object	NAS storage volume snapshot settings object
volume.snapshotPolicy.maxScheduledCount	Body	Integer	The maximum number of snapshots that can be saved
volume.snapshotPolicy.reservePercent	Body	Integer	Snapshot capacity ratio
volume.snapshotPolicy.schedule	Body	Object	Snapshot auto-create objects
volume.snapshotPolicy.schedule.time	Body	String	Snapshot auto-create time
volume.snapshotPolicy.schedule.timeOffset	Body	String	Time zone for snapshot auto-create
volume.snapshotPolicy.schedule.weekdays	Body	List	Days of the week that snapshots are automatically created An empty list means every day, and the days of the week are specified as a list of numbers from 0 (Sunday) to 6 (Saturday).
volume.createdAt	Body	String	NAS storage created time
volume.updatedAt	Body	String	NAS storage changed time

Change NAS storage settings

Change the settings for the specified NAS storage.

[Caution] To change the size of a replicated storage, you must change both the source storage and the target storage. If the size of the source storage and the target storage are different, replication might fail.

PATCH  /v1/volumes/{volume_id}
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
volume	Body	Object	O	NAS storage creation request object
volume.acl	Body	List	-	List of ACL IDs to set when creating NAS storage You can enter it in IP or CIDR format.
volume.description	Body	String	-	NAS storage description
volume.mountProtocol	Body	Object	-	Protocol settings object when creating NAS storage
volume.mountProtocol.cifsAuthIds	Body	List	-	List of CIFS Authentication IDs
volume.mountProtocol.protocol	Body	String	-	You cannot change the protocol of NAS storage that has already been created. When changing the `cifsAuthIds` field, you must specify the `cifs`in that field.
volume.sizeGb	Body	Integer	O	NAS storage size (GB) NAS storage can be set from a minimum of 300GB to a maximum of 10,000GB, in 100GB increments.
volume.snapshotPolicy	Body	Object	-	NAS storage volume snapshot settings object
volume.snapshotPolicy.maxScheduledCount	Body	Integer	-	The maximum number of snapshots that can be saved You can set a maximum of 30, and the first automatically created snapshot will be deleted when the maximum number of saves is reached.
volume.snapshotPolicy.reservePercent	Body	Integer	-	Snapshot capacity ratio
volume.snapshotPolicy.schedule	Body	Object	-	Snapshot auto-create objects If `null`, snapshot auto-creation will not be configured.
volume.snapshotPolicy.schedule.time	Body	String	-	Snapshot auto-create time
volume.snapshotPolicy.schedule.timeOffset	Body	String	-	Time zone for snapshot auto-create
volume.snapshotPolicy.schedule.weekdays	Body	List	-	Days of the week that snapshots are automatically created. An empty list means every day, and the days of the week are specified as a list of numbers from 0 (Sunday) to 6 (Saturday).

Request Example

{
  "volume": {
    "acl": [
      "10.0.1.0/24"
    ],
    "description": "Modified description",
    "mountProtocol": {
      "cifsAuthIds": [
        "cifs-test-id"
      ],
      "protocol": "cifs"
    },
    "sizeGb": 300,
    "snapshotPolicy": {
      "maxScheduledCount": 10,
      "reservePercent": 20,
      "schedule": {
        "time": "05:00",
        "timeOffset": "+09:00",
        "weekdays": [
          1,
          3,
          5
        ]
      }
    }
  }
}

Response

The response body does not contain any content other than header fields.

Connect an interface to NAS storage

Sets the interface for the specified NAS storage. The NAS storage is accessible from the set address and subnet. The accessible IP setting must be set separately in the access control (ACL) settings.

POST  /v1/volumes/{volume_id}/interfaces
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
interface	Body	Object	O	Interface Settings Object
interface.subnetId	Body	String	O	Specify an interface subnet

Request Example

{
  "interface":{
    "subnetId":"3e5b4d63-d143-420a-9263-208a447a2a3f"
  }
}

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
interface	Body	Object	Created interface information object
interface.id	Body	String	Created interface ID
interface.path	Body	String	Created interface path
interface.status	Body	String	Created interface status
interface.subnetId	Body	String	The subnet ID of the created interface
interface.tenantId	Body	String	The tenant ID of the created interface

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 201,
    "resultMessage": "Created"
  },
  "interface": {
    "id": "e7c6a340-6889-445b-ae2f-4e237b9afc9e",
    "path": null,
    "status": "BUILDING",
    "subnetId": "3e5b4d63-d143-420a-9263-208a447a2a3f",
    "tenantId": "3b6179e5fa6b499386b827357c4cb8c4"
  }
}

Delete an interface on NAS storage

Deletes the specified interface of the specified NAS storage.

DELETE  /v1/volumes/{volume_id}/interfaces/{interface_id}
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
interface_id	URL	String	O	Interface ID to delete

Response

The response body does not contain any content other than header fields.

View snapshot restore history

Returns a list of snapshot restore history for the specified storage.

GET  /v1/volumes/{volume_id}/restore-histories
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
limit	String	Query	X	Number of resources to expose on a page
page	String	Query	X	Page to search
sort	String	Query	X	Name of the field to sort by Describe it in the form `{key}:{direction}`. Example: `snapshotId:asc`, `requestedAt:desc` Possible key values: `snapshotId`, `snapshotName`, `requestedAt`, `restoredAt`, `requestedUser`, `requestedIp`, `result`

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
paging	Body	Object	About the page
paging.limit	Body	Integer	Number of resources exposed on a page
paging.page	Body	Integer	Current page number
paging.totalCount	Body	Integer	Total Count
restoreHistories	Body	List	Snapshot restore history object list
restoreHistories.requestedAt	Body	String	When the snapshot restore was requested
restoreHistories.requestedIp	Body	String	The address from which the snapshot restore was requested
restoreHistories.requestedUser	Body	String	The user ID that requested the snapshot restore
restoreHistories.restoredAt	Body	String	When the snapshot restore completed
restoreHistories.result	Body	String	Snapshot restore results
restoreHistories.snapshotId	Body	String	Snapshot ID to restore
restoreHistories.snapshotName	Body	String	Snapshot name to restore
restoreHistories.volumeId	Body	String	ID of the restored NAS storage

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 200,
    "resultMessage": "Success"
  },
  "paging": {
    "limit": 50,
    "page": 1,
    "totalCount": 1
  },
  "restoreHistories": [
    {
      "requestedAt": "2025-04-01T08:29:28+00:00",
      "requestedIp": "10.163.23.45",
      "requestedUser": "14025c4b-cc93-4f97-9416-a8001cc771c1",
      "restoredAt": "2025-04-01T08:29:34+00:00",
      "result": "SUCCESS",
      "snapshotId": "5e9745a5-0ed3-11f0-b0e3-d039eaa3e920",
      "snapshotName": "TEST-SNAPSHOT-IMM-1",
      "volumeId": "70787a7e-605b-4447-b950-46aa3297e0ed"
    }
  ]
}

View NAS storage usage

Returns the usage status of the specified NAS storage.

GET  /v1/volumes/{volume_id}/usage
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
usage	Body	Object	NAS storage usage object
usage.snapshotReserveGb	Body	Integer	The amount of space reserved for snapshots on NAS storage
usage.usedGb	Body	Integer	NAS storage usage

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 200,
    "resultMessage": "Success"
  },
  "usage": {
    "snapshotReserveGb": 30,
    "usedGb": 2
  }
}

Snapshots

List Snapshots

View a list of snapshots.

GET  /v1/volumes/{volume_id}/snapshots
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
snapshots	Body	List	Snapshot info object list
snapshots.id	Body	String	Snapshot ID
snapshots.name	Body	String	Snapshot name
snapshots.size	Body	Integer	Snapshot size
snapshots.type	Body	String	Snapshot types - `NORMAL`: Snapshots created by the user - `SCHEDULED`: Snapshots created by Auto Create Snapshot - `MIRROR`: Snapshots created by replication
snapshots.preserved	Body	Boolean	Whether snapshots are made undeletable by the system
snapshots.createdAt	Body	String	Snapshot creation time

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 201,
    "resultMessage": "Created"
  },
  "snapshots": [
    {
      "createdAt": "2025-04-01T09:34:27+00:00",
      "id": "8151fe33-0edc-11f0-b0e3-d039eaa3e920",
      "name": "TEST-SNAPSHOT-1",
      "preserved": false,
      "size": 3112960,
      "type": "NORMAL"
    }
  ]
}

Create Snapshots

Creates a snapshot of the specified NAS storage.

POST  /v1/volumes/{volume_id}/snapshots
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
snapshot	Body	Object	O	Snapshot creation objects
snapshot.name	Body	String	O	Snapshot name

Request Example

{
  "snapshot": {
    "name": "TEST-SNAPSHOT-1"
  }
}

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
snapshot	Body	Object	Snapshot information objects
snapshot.id	Body	String	Snapshot ID
snapshot.name	Body	String	Snapshot name
snapshot.size	Body	Integer	Snapshot size
snapshot.type	Body	String	Snapshot types - `NORMAL`: Snapshots created by the user - `SCHEDULED`: Snapshots created by Auto Create Snapshot - `MIRROR`: Snapshots created by replication
snapshot.preserved	Body	Boolean	Whether snapshots are made undeletable by the system
snapshot.createdAt	Body	String	Snapshot creation time

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 201,
    "resultMessage": "Created"
  },
  "snapshot": {
    "createdAt": "2025-04-01T09:34:27+00:00",
    "id": "8151fe33-0edc-11f0-b0e3-d039eaa3e920",
    "name": "TEST-SNAPSHOT-1",
    "preserved": false,
    "size": 3112960,
    "type": "NORMAL"
  }
}

Delete Snapshots

Deletes a snapshot of the specified NAS storage.

DELETE  /v1/volumes/{volume_id}/snapshots/{snapshot_id}
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
snapshot_id	URL	String	O	Snapshot ID

Response

The response body does not contain any content other than header fields.

View Snapshot

Returns details of the specified snapshot.

GET  /v1/volumes/{volume_id}/snapshots/{snapshot_id}
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
snapshot_id	URL	String	O	Snapshot ID
showReclaimableSpace	Query	Boolean	-	Whether to expose `the reclaimableSpace` entry, which indicates the amount of space reclaimed when a snapshot is deleted.

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
snapshot	Body	Object	Snapshot information objects
snapshot.id	Body	String	Snapshot ID
snapshot.name	Body	String	Snapshot name
snapshot.size	Body	Integer	Snapshot size
snapshot.type	Body	String	Snapshot types - `NORMAL`: Snapshots created by the user - `SCHEDULED`: Snapshots created by Auto Create Snapshot - `MIRROR`: Snapshots created by replication
snapshot.preserved	Body	Boolean	Whether snapshots are made undeletable by the system
snapshot.createdAt	Body	String	Snapshot creation time

Restore Snapshot

Restores NAS storage to the specified snapshot.

POST  /v1/volumes/{volume_id}/snapshots/{snapshot_id}/restore
X-Auth-Token: {token-id}

Request

This API does not require a request body.

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
snapshot_id	URL	String	O	Snapshot ID

Response

The response body does not contain any content other than header fields.

Set up NAS storage replication

Set up replication

Set up replication of the specified NAS storage. The selectable region ranges for each replication target project can be found in the table below.

Target project	Selectable region
Same project within an organization	Other regions
Other projects in an organization	All regions

[Caution] The size of the target storage for replication must be the same as the source storage. If the sizes of the source and target storages differ, the replication may fail.

[Note] To set up encryption on the target storage, you must configure a separate encryption keystore specific to the project or region the target storage belongs to.

[Note] If the source storage uses the CIFS protocol, the target storage must also use CIFS. To do this, you must create separate CIFS credentials (different from the source) and specify it in thecifsAuthIds field of the request body.

POST  /v1/volumes/{volume_id}/volume-mirrors
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	Source NAS storage ID
volumeMirror	Body	Object	O	NAS storage replication settings request object
volumeMirror.dstRegion	Body	String	O	The region of replication target storage
volumeMirror.dstTenantId	Body	String	O	The tenant ID of the replication target storage
volumeMirror.dstVolume	Body	Object	O	Replication target storage request object
volumeMirror.dstVolume.acl	Body	List	-	List of ACL IDs to set when creating NAS storage You can enter it in IP or CIDR format.
volumeMirror.dstVolume.description	Body	String	-	NAS storage description
volumeMirror.dstVolume.encryption	Body	Object	-	Encryption settings object when creating NAS storage
volumeMirror.dstVolume.encryption.enabled	Body	Boolean	-	Whether to enable encryption settings After the encryption keystore is set up, setting its field to `true`enables encryption.
volumeMirror.dstVolume.interfaces	Body	List	-	List of interfaces to access NAS storage
volumeMirror.dstVolume.interfaces.subnetId	Body	String	-	The subnet ID of the NAS storage interface
volumeMirror.dstVolume.mountProtocol	Body	Object	-	Protocol settings object when creating NAS storage
volumeMirror.dstVolume.mountProtocol.cifsAuthIds	Body	List	-	List of CIFS Authentication IDs No input required for NFS protocol selection
volumeMirror.dstVolume.mountProtocol.protocol	Body	String	O	Specifying protocols when mounting NAS storage You can choose between `NFS` and `CIFS`.
volumeMirror.dstVolume.name	Body	String	O	NAS storage name
volumeMirror.dstVolume.sizeGb	Body	Integer	O	NAS storage size (GB) NAS storage can be set from a minimum of 300GB to a maximum of 10,000GB, in 100GB increments.
volumeMirror.dstVolume.snapshotPolicy	Body	Object	-	NAS storage volume snapshot settings object
volumeMirror.dstVolume.snapshotPolicy.maxScheduledCount	Body	Integer	-	The maximum number of snapshots that can be saved You can set a maximum of 30, and the first automatically created snapshot will be deleted when the maximum number of saves is reached.
volumeMirror.dstVolume.snapshotPolicy.reservePercent	Body	Integer	-	Snapshot capacity ratio
volumeMirror.dstVolume.snapshotPolicy.schedule	Body	Object	-	Snapshot auto-create objects If `null`, snapshot auto-creation will not be configured.
volumeMirror.dstVolume.snapshotPolicy.schedule.time	Body	String	-	Snapshot auto-create time
volumeMirror.dstVolume.snapshotPolicy.schedule.timeOffset	Body	String	-	Time zone for snapshot auto-create
volumeMirror.dstVolume.snapshotPolicy.schedule.weekdays	Body	List	-	Days of the week that snapshots are automatically created. An empty list means every day, and the days of the week are specified as a list of numbers from 0 (Sunday) to 6 (Saturday).

Request Example

{
  "volumeMirror": {
    "dstRegion": "KR1",
    "dstTenantId": "7debf04e6a7248c98777229bcb004b69",
    "dstVolume": {
      "description": "Volume Mirror Test",
      "mountProtocol": {
        "protocol": "nfs"
      },
      "name": "TEST-NAS-MIRROR",
      "sizeGb": 300
    }
  }
}

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
volumeMirror	Body	Object	Replication Settings Creation Object
volumeMirror.id	Body	String	Replication setting ID
volumeMirror.role	Body	String	Replication roles - `SOURCE`: Source storage - `DESTINATION`: Target storage
volumeMirror.status	Body	String	Replication setting status - `INITIALIZED`: Setup complete - `UPDATING`: Updating settings - `DELETING`: Deleting settings - `PENDING`: Creating settings
volumeMirror.direction	Body	String	Replication direction - `FORWARD`: Source storage -> Replica storage - `REVERSE`: Replica storage -> Source storage
volumeMirror.directionChangedAt	Body	String	When to change replication direction
volumeMirror.dstProjectId	Body	String	The project ID of the replication target storage
volumeMirror.dstRegion	Body	String	The region of the replication target storage
volumeMirror.dstTenantId	Body	String	The tenant ID of the replication target storage
volumeMirror.dstVolumeId	Body	String	The NAS storage ID of the replication target storage
volumeMirror.dstVolumeName	Body	String	The NAS storage name of the replication target storage
volumeMirror.srcProjectId	Body	String	The project ID of the source storage
volumeMirror.srcRegion	Body	String	The region of the source storage
volumeMirror.srcTenantId	Body	String	The tenant ID of the source storage
volumeMirror.srcVolumeId	Body	String	The NAS storage ID of the source storage
volumeMirror.srcVolumeName	Body	String	Source storage NAS storage name
volumeMirror.createdAt	Body	String	Replication creation time

Example response

{
  "header": {
    "isSuccessful": true,
    "resultCode": 201,
    "resultMessage": "Created"
  },
  "volumeMirror": {
    "createdAt":"2025-04-01T06:45:45+00:00",
    "direction": "FORWARD",
    "directionChangedAt": null,
    "dstProjectId": "K3y0CgOy",
    "dstRegion": "KR2",
    "dstTenantId": "3b6179e5fa6b499386b827357c4cb8c4",
    "dstVolumeId": "e09281d2-0b1c-48a9-8a01-0098aa59f624",
    "dstVolumeName": "TEST-NAS-MIRROR-1",
    "id": "8116892c-7306-48be-9e3d-143311b2254c",
    "role": "SOURCE",
    "srcProjectId": "K3y0CgOy",
    "srcRegion": "KR1",
    "srcTenantId": "3b6179e5fa6b499386b827357c4cb8c4",
    "srcVolumeId": "fc8b111a-32b7-45d3-b123-ff3ecaaf768a",
    "srcVolumeName": "TEST-NAS-1",
    "status": "PENDING"
  }
}

Disable Replication Settings

Disable replication settings for the specified NAS storage.

DELETE  /v1/volumes/{volume_id}/volume-mirrors/{volume_mirror_id}
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
volume_mirror_id	URL	String	O	Replication setting ID

Response

The response body does not contain any content other than header fields.

Change the replication direction

Change the direction of replication between source and target storage.

POST  /v1/volumes/{volume_id}/volume-mirrors/{volume_mirror_id}/invert-direction
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
volume_mirror_id	URL	String	O	Replication setting ID

Response

The response body does not contain any content other than header fields.

Start Replication

Start replication from the source storage to the target storage.

POST  /v1/volumes/{volume_id}/volume-mirrors/{volume_mirror_id}/start
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
volume_mirror_id	URL	String	O	Replication setting ID

Response

The response body does not contain any content other than header fields.

View replication status

Returns the most recent replication state.

GET  /v1/volumes/{volume_id}/volume-mirrors/{volume_mirror_id}/stat
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
volume_mirror_id	URL	String	O	Replication setting ID

Response

Name	Type	Format	Description
header	Body	Object	Header Objects
volumeMirrorStat	Body	Object	Replication status object
volumeMirrorStat.lastSuccessTransferBytes	Body	Integer	Size of data transferred in the last successful replication (bytes)
volumeMirrorStat.lastSuccessTransferEndTime	Body	String	Last successful replication completion time
volumeMirrorStat.lastTransferBytes	Body	Integer	Size of data transferred in the last replication run (bytes)
volumeMirrorStat.lastTransferEndTime	Body	String	Last completed replication time
volumeMirrorStat.lastTransferStatus	Body	String	Recent replication run results
volumeMirrorStat.status	Body	String	Replication setting status - `ACTIVE`: Replication active status - `UPDATING`: Updating settings - `DELETING`: Deleting settings - `PENDING`: Creating settings - `HALT`: Halted replication status - `RETRIEVE FAILED`: Temporary failure to obtain information

Stop replication

Stops replication from the source storage to the target storage.

POST  /v1/volumes/{volume_id}/volume-mirrors/{volume_mirror_id}/stop
X-Auth-Token: {token-id}

Request

Name	Type	Format	Required	Description
X-Auth-Token	Header	String	O	Token ID
volume_id	URL	String	O	NAS storage ID
volume_mirror_id	URL	String	O	Replication setting ID

Response

The response body does not contain any content other than header fields.

Storage > NAS > API Guide
Response Common Information
[Response Header]
NAS Storage
List NAS Storage
Create NAS storage
Delete NAS storage
View NAS storage
Change NAS storage settings
Connect an interface to NAS storage
Delete an interface on NAS storage
View snapshot restore history
View NAS storage usage
Snapshots
List Snapshots
Create Snapshots
Delete Snapshots
View Snapshot
Restore Snapshot
Set up NAS storage replication
Set up replication
Disable Replication Settings
Change the replication direction
Start Replication
View replication status
Stop replication

TOP

Storage > NAS > API Guide

Response Common Information

[Response Header]

NAS Storage

List NAS Storage

Request

Response

Create NAS storage

Request

Response

Delete NAS storage

Request

Response

View NAS storage

Request

Response

Change NAS storage settings

Request

Response

Connect an interface to NAS storage

Request

Response

Delete an interface on NAS storage

Request

Response

View snapshot restore history

Request

Response

View NAS storage usage

Request

Response

Snapshots

List Snapshots

Request

Response

Create Snapshots

Request

Response

Delete Snapshots

Request

Response

View Snapshot

Request

Response

Restore Snapshot

Request

Response

Set up NAS storage replication

Set up replication

Request

Response

Disable Replication Settings

Request

Response

Change the replication direction

Request

Response

Start Replication

Request

Response

View replication status

Request

Response

Stop replication

Request

Response

Table of Contents