getNasVolumeInstanceList

VPC環境で利用できます。

NASボリュームインスタンスリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vnas/v2/getNasVolumeInstanceList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

NAS (VPC) APIで共通して使用されるヘッダの詳細は、NAS (VPC)のリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照(デフォルト: `KR`)
`zoneCode`	String	Optional	ゾーンコード getZoneListを参照
`nasVolumeInstanceNoList.N`	List[String]	Optional	NASボリュームインスタンス番号リストコンソールまたはgetNasVolumeInstanceListを参照 <例> nasVolumeInstanceNoList.1=1234&nasVolumeInstanceNoList.2=2345
`volumeName`	String	Optional	NASボリューム名
`volumeAllotmentProtocolTypeCode`	String	Optional	NASボリューム割り当てプロトコルタイプコード `NFS` \| `CIFS` `NFS`: CentOS、Ubuntuなど Linuxサーバでマウント可能 `CIFS`: Windows Serverでマウント可能
`isEventConfiguration`	Boolean	Optional	イベントを設定するかどうか `true` \| `false` `true`: 設定 `false`: 設定しない
`isSnapshotConfiguration`	Boolean	Optional	スナップショットを設定するかどうか `true` \| `false` `true`: 設定 `false`: 設定しない
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用して結果値をページング処理
`pageSize`	Integer	Conditional	ページング時に表示する各ページのサイズ `pageNo`入力時、必須 `pageNo`、`pageSize`を利用して結果値をページング処理
`sortedBy`	String	Optional	ソート対象 `nasVolumeInstanceNo` \| `volumeName` \| `volumeTotalSize` `nasVolumeInstanceNo`: NASボリュームインスタンス番号 `volumeName`: ボリューム名 `volumeTotalSize`: ボリューム全体のサイズ
`sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順
`responseFormatType`	String	Optional	レスポンス結果の形式タイプ `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/getNasVolumeInstanceList
?regionCode=KR
&zoneCode=KR-2
&isEventConfiguration=false
&isSnapshotConfiguration=false
&pageNo=1
&pageSize=2
&sortedBy=nasVolumeInstanceNo
&sortingOrder=ASC
&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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、NasVolumeInstanceListをご参照ください。

レスポンスステータスコード

NAS (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、NAS (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "getNasVolumeInstanceListResponse": {
        "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"
    }
}