---
title: "Subnetリストの照会"
slug: "analytics-vpcsearchengine-cluster-getsubnetlist"
tags: ["Search Engine Service"]
updated: 2026-09-17T09:57:29Z
published: 2026-09-17T09:57:29Z
canonical: "api.ncloud-docs.com/analytics-vpcsearchengine-cluster-getsubnetlist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Subnetリストの照会

VPC環境で利用できます。

使用できる Subnetリストを照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /api/v2/cluster/getSubnetList (韓国リージョン) |
| GET | /api/sgn-v2/cluster/getSubnetList (シンガポールリージョン) |
| GET | /api/jpn-v2/cluster/getSubnetList (日本リージョン) |

### リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、[Search Engine Serviceのリクエストヘッダ](/docs/ja/analytics-vpcsearchengine#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `softwareProductCode` | String | Required | OSタイプコード - [OSタイプの照会](/docs/ja/analytics-vpcsearchengine-cluster-getosproductlist)を参照 |
| `vpcNo` | Integer | Required | VPC番号 - [VPCリストの照会](/docs/ja/analytics-vpcsearchengine-cluster-getvpclist)を参照 |

### リクエスト例

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

```
curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList?softwareProductCode=SW.VELST.OS.LNX64.ROCKY.0808.B050&vpcNo=93***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

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

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `code` | Integer | - | レスポンスコード |
| `message` | String | - | レスポンスメッセージ |
| `result` | Object | - | レスポンス結果 |
| `result.content` | Array | - | [Subnetリスト](/docs/ja/analytics-vpcsearchengine-cluster-getsubnetlist#resultcontent) |
| `requestId` | String | - | リクエスト ID - UUID形式 |

#### `result.content`

`result.content`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `isPublic` | Boolean | - | Public Subnetかどうか - `true` \| `false` - `true`: Public Subnet - `false`: Private Subnet |
| `statusCode` | String | - | Subnet状態 |
| `subnet` | String | - | Subnetの IPv4 CIDRブロック |
| `subnetName` | String | - | Subnet名 |
| `subnetNo` | Integer | - | Subnet番号 |
| `vpcName` | String | - | VPC名 |
| `vpcNo` | Integer | - | VPC番号 |
| `zoneName` | String | - | ゾーン名 |
| `zoneNo` | Integer | - | ゾーン番号 |
| `permission` | String | - | サブアカウントは使用可能かどうか - `Allow` \| `Deny` - `Allow`: 使用可能 - `Deny`: 使用不可 - `Deny`の場合、サブアカウントに[getSubnetDetail](/docs/ja/networking-vpc-subnetmanagement-getsubnetdetail)権限を付与すると使用可能 |

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

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Search Engine Serviceのレスポンスステータスコード](/docs/ja/analytics-vpcsearchengine#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "content": [
            {
                "isPublic": false,
                "statusCode": "RUN",
                "subnet": "10.0.20.0/24",
                "subnetName": "s1-hd-pri",
                "subnetNo": 20****,
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "permission": "Allow"
            },
            {
                "isPublic": true,
                "statusCode": "RUN",
                "subnet": "10.0.0.0/24",
                "subnetName": "s1-hd-pub",
                "subnetNo": 20****,
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "permission": "Allow"
            }
        ]
    },
    "requestId": "b4765a66-****-****-****-0adc09cb2cc7"
}
```