setNasVolumeAccessControl

Prev Next

Can be used in a VPC environment.

Overview

Sets access control of NAS volume instances whose volume assignment protocol is NFS with the given server instance number list.
You can view the access control permissions that have been set up through the getNasVolumeAccessControlRuleList action.

Request

Request parameter

Parameter name Requirement status Type Restrictions Description
regionCode No String - Region code
Determines the region of the NAS volume instance for which access control will be set.
regionCode can be obtained through the getRegionList action.
Default: Selects the first region of the getRegionList search results.
nasVolumeInstanceNo Yes String - Number of NAS volume instance for which the access control will be set
nasVolumeInstanceNo can be obtained through the getNasVolumeInstanceList action.
Access control can only be set up for the NAS volume instances whose volume assignment protocol type is NFS.
accessControlRuleList.N.serverInstanceNo Yes String - Instance number of server to be set with access control
serverInstanceNo can be obtained through the getServerInstanceList action.
accessControlRuleList.N.writeAccess No Boolean - Whether writing permission is allowed
Options : true | false
Default : true

Response

Response data type

  • NasVolumeInstanceList type
NasVolumeInstanceList extends CommonResponse
private Integer totalRows;
private List<NasVolumeInstance> 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 setNasVolumeAccessControl --regionCode KR --nasVolumeInstanceNo ***3901 --accessControlRuleList "serverInstanceNo=***4299, writeAccess=true"

Response examples

<setNasVolumeAccessControlResponse>
  <requestId>b6a4308d-48f3-4f0d-90a0-c00f3c41da54</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>0.0</snapshotVolumeConfigurationRatio>
      <snapshotVolumeSize>0</snapshotVolumeSize>
      <isSnapshotConfiguration>false</isSnapshotConfiguration>
      <isEventConfiguration>false</isEventConfiguration>
      <regionCode>KR</regionCode>
      <zoneCode>KR-1</zoneCode>
      <nasVolumeServerInstanceNoList>
        <serverInstanceNo>***4299</serverInstanceNo>
      </nasVolumeServerInstanceNoList>
      <isEncryptedVolume>false</isEncryptedVolume>
      <nasVolumeInstanceCustomIpList>
        <nasVolumeInstanceCustomIp>
          <customIp>10.0.0.1</customIp>
        </nasVolumeInstanceCustomIp>
      </nasVolumeInstanceCustomIpList>
    </nasVolumeInstance>
  </nasVolumeInstanceList>
</setNasVolumeAccessControlResponse>