setNasVolumeAccessControl

Available in VPC

Remove the existing access control on the NAS volume instance and set a new one.

Note

The set access control rules can be viewed through the getNasVolumeAccessControlRuleList action.

Requests

The following describes the request format for the endpoint. The request format is as follows.

Method	URI
GET, POST	/setNasVolumeAccessControl

Request headers

For headers common to all NAS APIs, see NAS common headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the NAS volume instance for which you want to set access control Check through the getRegionList action (default: `KR`)
`nasVolumeInstanceNo`	String	Required	Number of the NAS volume instance for which you want to set access control Check through the getNasVolumeInstanceList action Only NAS volume instances with volume allocation protocol type of NFS can be set to access control
`accessControlRuleList.N.serverInstanceNo`	String	Required	Number of server instance to set with access control Check through the getServerInstanceList action
`accessControlRuleList.N.writeAccess`	Boolean	Optional	Writing permissions `true` (default) \| `false` `true`: set `false`: not set
`responseFormatType`	String	Optional	Format type of the response result `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/setNasVolumeAccessControl?regionCode=KR&nasVolumeInstanceNo=23380000&accessControlRuleList.1.serverInstanceNo=23320000&accessControlRuleList.1.writeAccess=true&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Responses

The following describes the response format.

Response body

See NasVolumeInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

{
    "setNasVolumeAccessControlResponse": {
        "totalRows": 1,
        "nasVolumeInstanceList": [
            {
                "nasVolumeInstanceNo": "23380000",
                "nasVolumeInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "NAS create"
                },
                "nasVolumeInstanceOperation": {
                    "code": "NULL",
                    "codeName": "NAS NULL OP"
                },
                "nasVolumeInstanceStatusName": "created",
                "createDate": "2024-04-02T10:06:29+0900",
                "nasVolumeDescription": "",
                "mountInformation": "169.254.00.00:/n2768364_vn18e9c000000",
                "volumeAllotmentProtocolType": {
                    "code": "NFS",
                    "codeName": "NFS"
                },
                "volumeName": "n2768364_vn18e9c000000",
                "volumeTotalSize": 644245094400,
                "volumeSize": 644245094400,
                "snapshotVolumeConfigurationRatio": 0.0,
                "snapshotVolumeSize": 0,
                "isSnapshotConfiguration": false,
                "isEventConfiguration": false,
                "regionCode": "KR",
                "zoneCode": "KR-2",
                "nasVolumeServerInstanceNoList": [
                    "23320000"
                ],
                "isEncryptedVolume": false,
                "nasVolumeInstanceCustomIpList": [],
                "isReturnProtection": false
            }
        ],
        "requestId": "",
        "returnCode": "0",
        "returnMessage": "success"
    }
}