Available in VPC
View the types of server images available when creating a cluster.
Requests
The following describes the request format for the endpoint. The request format is as follows.
| Method | URI |
|---|---|
| GET | /vnks/v2/option/server-image (Korea Region) |
| GET | /vnks/sgn-v2/option/server-image (Singapore Region) |
| GET | /vnks/jpn-v2/option/server-image (Japan Region) |
Request headers
For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request headers.
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
hypervisorCode |
String | Optional | Hypervisor type
|
Request example
The following is a sample request.
curl --location 'https://nks.apigw.ntruss.com/vnks/v2/option/server-image' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
Responses
The following describes the response format.
Response syntax
The response syntax is as follows.
[
{
"label": "string",
"value": "string"
},
{
"label": "string",
"value": "string"
}
]
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
label |
String | - | Server image name |
value |
String | - | Server product code |
Response status codes
For information about the HTTP status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.
Response example
The following is a sample response.
For XEN
[
{
"label": "ubuntu-20.04-64-server",
"value": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.WRKND.B050"
},
{
"label": "ubuntu-18.04-64-server",
"value": "SW.VSVR.OS.LNX64.UBNTU.SVR1804.WRKND.B050"
}
]
For KVM
[
{
"label": "ubuntu-22.04-nks-wknd",
"value": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003|3434193"
},
{
"label": "ubuntu-20.04-nks",
"value": "SW.VSVR.OS.LNX64.UBNTU.SVR20.WRKND.G003|3063991"
},
{
"label": "ubuntu-22.04-gpu-wknd",
"value": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003|3466796"
}
]