Get subnet list

Prev Next

Available in VPC

Get the list of available subnets.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v2/cluster/getSubnetList (Korea Region)
GET /api/sgn-v2/cluster/getSubnetList (Singapore Region)
GET /api/jpn-v2/cluster/getSubnetList (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
softwareProductCode String Required Operating system type code
vpcNo Integer Required VPC number

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code Integer - Response code
message String - Response message
result Object - Response result
result.content Array - Subnet list
requestId String - ID for the request
  • UUID format

result.content

The following describes result.content.

Field Type Required Description
isPublic Boolean - Whether it is a public subnet
  • true | false
    • true: public subnet
    • false: private subnet
statusCode String - Subnet status
subnet String - Subnet's IPv4 CIDR block
subnetName String - Subnet name
subnetNo Integer - Subnet number
vpcName String - VPC name
vpcNo Integer - VPC number
zoneName String - Zone name
zoneNo Integer - Zone number
permission String - Sub account availability
  • Allow | Deny
    • Allow: available
    • Deny: unavailable
  • If it is Deny, it becomes available when granting the getSubnetDetail permission to the sub account.

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

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