setNasVolumeAccessControl

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a Classic environment.

Overview

Sets the access control for a NAS volume instance.

Description

Sets the access control for NAS.
The access control permissions that have been set up can be viewed through the getNasVolumeAccessControlRuleList action.

Request parameter

Parameter name	Requirement status	Type	Restrictions	Description
nasVolumeInstanceNo	Yes	String		- NAS volume instance number You can obtain nasVolumeInstanceNo through the getNasVolumeInstanceList action.
accessControlRuleList.N.serverInstanceNo	No	String	It can't be duplicated.	- Server instance number You can obtain serverInstanceNo through the getServerInstanceList action. Only instance numbers of the servers owned by the user can be entered. Enter either serverInstanceNo or customIp, not both, for a single rule.
accessControlRuleList.N.customIp	No	String	It can't be duplicated.	- Custom IP You can obtain customIp through the getServerInstanceList action. Only private IPs can be set. `Public IPs can't be set.` Enter either serverInstanceNo or customIp, not both, for a single rule.
accessControlRuleList.N.writeAccess	No	Boolean		- Whether writing permission is allowed Options: true \| false Default: true

Response data type

NasVolumeInstanceList type

NasVolumeInstanceList extends CommonResponse
private int totalRows;
private List<NasVolumeInstance> nasVolumeInstanceList = new ArrayList<NasVolumeInstance>();

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 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 Region region;
private Zone zone;
private Boolean isReturnProtection;
private List<NasVolumeInstanceCustomIp> nasVolumeInstanceCustomIpList = new ArrayList<NasVolumeInstanceCustomIp>();
private List<ServerInstance> nasVolumeServerInstanceList = new ArrayList<ServerInstance>();

Examples

Call

ncloud server setNasVolumeAccessControl --nasVolumeInstanceNo ***7367 --accessControlRuleList "customIp='***.***.1.1', writeAccess=true" --accessControlRuleList "customIp='***.***.1.2', writeAccess=true"

Response

{
  "setNasVolumeAccessControlResponse": {
    "requestId": "f7c2b5f8-a38c-467c-a306-d6b3895cf760",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "nasVolumeInstanceList": [
      {
        "nasVolumeInstanceNo": "***7367",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS create"
        },
        "nasVolumeInstanceOperation": {
          "code": "NULL",
          "codeName": "NAS NULL OP"
        },
        "nasVolumeInstanceStatusName": "created",
        "createDate": "2018-02-23T15:49:22+0900",
        "nasVolumeInstanceDescription": "",
        "mountInformation": "***.***.84.81:/n***212_mktest",
        "volumeAllotmentProtocolType": {
          "code": "NFS",
          "codeName": "NFS"
        },
        "volumeName": "n***212_mktest",
        "volumeTotalSize": 21474836480,
        "volumeSize": 21474836480,
        "snapshotVolumeConfigurationRatio": 0.0,
        "snapshotVolumeSize": 0,
        "isSnapshotConfiguration": false,
        "isEventConfiguration": false,
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo" : "1"
        },
        "isReturnProtection": false,
        "nasVolumeInstanceCustomIpList": [
          {
            "customIp": "***.***.1.1"
          },
          {
            "customIp": "***.***.1.2"
          }
        ],
        "nasVolumeServerInstanceList": []
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<setNasVolumeAccessControlResponse>
  <requestId>f7c2b5f8-a38c-467c-a306-d6b3895cf760</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstanceNo>***7367</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-02-23T15:49:22+0900</createDate>
    <nasVolumeInstanceDescription></nasVolumeInstanceDescription>
    <mountInformation>***.***.84.81:/n***212_mktest</mountInformation>
    <volumeAllotmentProtocolType>
      <code>NFS</code>
      <codeName>NFS</codeName>
    </volumeAllotmentProtocolType>
    <volumeName>n***212_mktest</volumeName>
    <volumeTotalSize>21474836480</volumeTotalSize>
    <volumeSize>21474836480</volumeSize>
    <snapshotVolumeConfigurationRatio>0</snapshotVolumeConfigurationRatio>
    <snapshotVolumeSize>0</snapshotVolumeSize>
    <isSnapshotConfiguration>false</isSnapshotConfiguration>
    <isEventConfiguration>false</isEventConfiguration>
    <region>
      <regionNo>1</regionNo>
      <regionCode>KR</regionCode>
      <regionName>Korea</regionName>
    </region>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
    <isReturnProtection>false</isReturnProtection>
    <nasVolumeInstanceCustomIpList>
      <customIp>***.***.1.1</customIp>
    </nasVolumeInstanceCustomIpList>
    <nasVolumeInstanceCustomIpList>
      <customIp>***.***.1.2</customIp>
    </nasVolumeInstanceCustomIpList>
    <nasVolumeServerInstanceList/>
  </nasVolumeInstanceList>
</setNasVolumeAccessControlResponse>

Was this article helpful?

What's Next

addNasVolumeAccessControl

Table of contents

Overview
Description
Request parameter
Response data type
Examples