changeNasVolumeSnapshotConfiguration

Prev Next

Can be used in a VPC environment.

Overview

Changes the snapshot configuration for the NAS volume instance.

Request

Request parameter

Parameter name Requirement status Type Restrictions Description
regionCode No String - Region code
Decides the region of the NAS volume instance whose snapshot configuration will be changed.
regionCode: It can be obtained through the getRegionList action.
Default: Selects the first region of the getRegionList search results.
nasVolumeInstanceNo Yes String - Instance number of NAS volume where the snapshot configuration will be modified
nasVolumeInstanceNo: It can be obtained 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 of the week can be set if you set up automatic snapshot creation.
It's only valid when the snapshot volume configuration ratio is not 0.
Up to 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 (hours) - Automatic snapshot creation cycle time
Time must be set if you configure automatic snapshot creation.

Response

Response data type

  • NasVolumeInstanceList type
NasVolumeInstanceList extends CommonResponse
private Integer totalRows;
private List nasVolumeInstanceList = new ArrayList<>();
NasVolumeInstance
private String nasVolumeInstanceNo;
private CommonCode nasVolumeInstanceStatus;
private CommonCode nasVolumeInstanceOperation;
private String nasVolumeInstanceStatusName;
private Date createDate;
private String nasVolumeDescription;
private String mountInformation;
private CommonCode volumeAllotmentProtocolType;
private String volumeName;
private Long volumeTotalSize;
private Long volumeSize;
private Float snapshotVolumeConfigurationRatio;
private CommonCode snapshotVolumeConfigPeriodType;
private CommonCode snapshotVolumeConfigDayOfWeekType;
private Integer snapshotVolumeConfigTime;
private Long snapshotVolumeSize;
private Boolean isSnapshotConfiguration;
private Boolean isEventConfiguration;
private String regionCode;
private String zoneCode;
private ServerInstanceNoList nasVolumeServerInstanceNoList;
private Boolean isEncryptedVolume;
private List<NasVolumeInstanceCustomIp> nasVolumeInstanceCustomIpList;
private Boolean isReturnProtection;
NasVolumeInstanceCustomIp
private String customIp;

Examples

Request examples

ncloud vnas changeNasVolumeSnapshotConfiguration --regionCode KR --nasVolumeInstanceNo ***3901 --snapshotVolumeConfigurationRatio 10 --snapshotVolumeConfigDayOfWeekTypeCode "-1" --snapshotVolumeConfigTime 1

Response examples

<changeNasVolumeSnapshotConfigurationResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstance>
      <nasVolumeInstanceNo>***3901</nasVolumeInstanceNo>
      <nasVolumeInstanceStatus>
        <code>CREAT</code>
        <codeName>NAS create</codeName>
      </nasVolumeInstanceStatus>
      <nasVolumeInstanceOperation>
        <code>NULL</code>
        <codeName>NAS NULL OP</codeName>
      </nasVolumeInstanceOperation>
      <nasVolumeInstanceStatusName></nasVolumeInstanceStatusName>
      <createDate>1970-01-01T09:00:02+0900</createDate>
      <nasVolumeDescription></nasVolumeDescription>
      <mountInformation>***.***.0.20:/n***4567_test***</mountInformation>
      <volumeAllotmentProtocolType>
        <code>NFS</code>
        <codeName>NFS</codeName>
      </volumeAllotmentProtocolType>
      <volumeName>n***4567_test***</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>true</isSnapshotConfiguration>
      <isEventConfiguration>false</isEventConfiguration>
      <regionCode>KR</regionCode>
      <zoneCode>KR-1</zoneCode>
      <nasVolumeServerInstanceNoList>
        <serverInstanceNo>***4299</serverInstanceNo>
      </nasVolumeServerInstanceNoList>
      <isEncryptedVolume>false</isEncryptedVolume>
      <nasVolumeInstanceCustomIpList/>
      <isReturnProtection>false</isReturnProtection>
    </nasVolumeInstance>
  </nasVolumeInstanceList>
</changeNasVolumeSnapshotConfigurationResponse>