changeNasVolumeSnapshotConfiguration

Prev Next

Can be used in a Classic environment.

Overview

Change the snapshot configuration for the NAS volume instance.

Request

Request parameter

Parameter name Requirement status Type Restrictions Description
nasVolumeInstanceNo Yes String - NAS volume instance number where the snapshot configuration will be modified
You can obtain nasVolumeInstanceNo through the getNasVolumeInstanceList action.
snapshotVolumeConfigurationRatio Yes Integer Min: 0, Max: 99 (%) - Snapshot volume configuration ratio
Snapshots use the NAS volume capacity requested, and can be created within the ratio you set.
Snapshots are deleted, oldest first, if the set snapshot capacity is exceeded.
Setting the ratio to 0 will disable the snapshot configuration.
snapshotVolumeConfigDayOfWeekTypeCode No String - Automatic snapshot creation cycle day code
The day can be set if you set up automatic snapshot creation.
It's only valid when the snapshot volume configuration ratio is not 0.
7 snapshots for automatic creation cycle mode and unlimited snapshots for instant creation mode can be stored, within the snapshot capacity limit set.
Options:
-1 (every day)
0 (Sunday)
1 (Monday)
2 (Tuesday)
3 (Wednesday)
4 (Thursday)
5 (Friday)
6 (Saturday)
snapshotVolumeConfigTime Conditional Integer Min: 0, Max: 23 (hour) - Automatic snapshot creation cycle time
Time configuration must be set if you set up automatic snapshot creation.

Response

Response data type

  • NasVolumeInstanceList type
NasVolumeInstanceList extends CommonResponse
private int totalRows;
private List nasVolumeInstanceList = new ArrayList();
NasVolumeInstance
private String nasVolumeInstanceNo;
private CommonCode nasVolumeInstanceStatus;
private CommonCode nasVolumeInstanceOperation;
private String nasVolumeInstanceStatusName;
private Date createDate;
private String nasVolumeInstanceDescription;
private String mountInformation;
private CommonCode volumeAllotmentProtocolType;
private CommonCode snapshotVolumeConfigDayOfWeekType;
private String volumeName;
private long volumeTotalSize;
private long volumeSize;
private float snapshotVolumeConfigurationRatio;
private CommonCode snapshotVolumeConfigPeriodType;
private Integer snapshotVolumeConfigTime;
private long snapshotVolumeSize;
private Boolean isSnapshotConfiguration;
private Boolean isEventConfiguration;
private Region region;
private Zone zone;
private Boolean isReturnProtection;
private List nasVolumeInstanceCustomIpList = new ArrayList();
private List nasVolumeServerInstanceList = new ArrayList();

Examples

Request examples

ncloud server changeNasVolumeSnapshotConfiguration --nasVolumeInstanceNo 1084361 --snapshotVolumeConfigurationRatio 10 --snapshotVolumeConfigDayOfWeekTypeCode "-1" --snapshotVolumeConfigTime 1

Response examples

<changeNasVolumeSnapshotConfigurationResponse>
  <requestId>4bdfecee-76a8-487e-8c00-54733badf386</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstance>
      <nasVolumeInstanceNo>1084361</nasVolumeInstanceNo>
      <nasVolumeInstanceStatus>
        <code>CREAT</code>
        <codeName>NAS create</codeName>
      </nasVolumeInstanceStatus>
      <nasVolumeInstanceOperation>
        <code>NULL</code>
        <codeName>NAS NULL OP</codeName>
      </nasVolumeInstanceOperation>
      <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
      <createDate>2018-11-26T19:40:14+0900</createDate>
      <nasVolumeDescription></nasVolumeDescription>
      <mountInformation>10.250.53.74:/n2532613_testnas</mountInformation>
      <volumeAllotmentProtocolType>
        <code>NFS</code>
        <codeName>NFS</codeName>
      </volumeAllotmentProtocolType>
      <volumeName>n2532613_testnas</volumeName>
      <volumeTotalSize>536870912000</volumeTotalSize>
      <volumeSize>536870912000</volumeSize>
      <snapshotVolumeConfigurationRatio>10.0</snapshotVolumeConfigurationRatio>
      <snapshotVolumeConfigPeriodType>
        <code>DAY</code>
        <codeName>everyday</codeName>
      </snapshotVolumeConfigPeriodType>
      <snapshotVolumeConfigDayOfWeekType>
        <code>-1</code>
        <codeName>Everyday</codeName>
      </snapshotVolumeConfigDayOfWeekType>
      <snapshotVolumeConfigTime>1</snapshotVolumeConfigTime>
      <snapshotVolumeSize>0</snapshotVolumeSize>
      <isSnapshotConfiguration>false</isSnapshotConfiguration>
      <isEventConfiguration>false</isEventConfiguration>
      <region>
        <regionNo>1</regionNo>
        <regionCode>KR</regionCode>
        <regionName>Korea</regionName>
      </region>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>Pyeongchon zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
      <isReturnProtection>false</isReturnProtection>
      <nasVolumeInstanceCustomIpList/>
      <nasVolumeServerInstanceList/>
    </nasVolumeInstance>
  </nasVolumeInstanceList>
</changeNasVolumeSnapshotConfigurationResponse>