MENU
      getNasVolumeInstanceDetail

        getNasVolumeInstanceDetail


        Article summary

        Available in VPC

        View NAS volume instance details by using a NAS volume instance number.

        Requests

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

        MethodURI
        GET, POST/getNasVolumeInstanceDetail

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code of the NAS volume instance for which you want to view details
        nasVolumeInstanceNoStringRequiredNAS volume instance number for which you want to view details
        responseFormatTypeStringOptionalFormat 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/getNasVolumeInstanceDetail?regionCode=KR&nasVolumeInstanceNo=23380000&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}'
        Curl

        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.

        {
            "getNasVolumeInstanceDetailResponse": {
                "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": 536870912000,
                        "volumeSize": 536870912000,
                        "snapshotVolumeConfigurationRatio": 0.0,
                        "snapshotVolumeSize": 0,
                        "isSnapshotConfiguration": false,
                        "isEventConfiguration": false,
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "nasVolumeServerInstanceNoList": [],
                        "isEncryptedVolume": false,
                        "nasVolumeInstanceCustomIpList": [],
                        "isReturnProtection": false
                    }
                ],
                "requestId": "",
                "returnCode": "0",
                "returnMessage": "success"
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.