Available in VPC
Get changeable server specifications for each node in a search engine cluster.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/cluster/getNodeProductListForSpecChange/{serviceGroupInstanceNo} (Korea Region) |
POST | /api/sgn-v2/cluster/getNodeProductListForSpecChange/{serviceGroupInstanceNo} (Singapore Region) |
POST | /api/jpn-v2/cluster/getNodeProductListForSpecChange/{serviceGroupInstanceNo} (Japan Region) |
Request headers
For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
serviceGroupInstanceNo |
Integer | Required | Cluster instance number
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
softwareProductCode |
String | Required | Operating system type code
|
Request example
The request example is as follows:
curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getNodeProductListForSpecChange/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0708.B050"
}'
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.managerNodeProductList |
Array | - | Manager node server type list: Server type information |
result.dataNodeProductList |
Array | - | Data node server type list: Server type information |
result.masterNodeProductList |
Array | - | Master node server type list: Server type information |
requestId |
String | - | ID for the request
|
Server type information
The following describes the server type information.
Field | Type | Required | Description |
---|---|---|---|
productCode |
String | - | Server type code |
productName |
String | - | Server type name |
productKoreanName |
String | - | Server type name (Korean) |
productEnglishName |
String | - | Server type name (English) |
productJapaneseName |
String | - | Server type name (Japanese) |
productDesc |
String | - | Server description |
productKoreanDesc |
String | - | Server description (Korean) |
productEnglishDesc |
String | - | Server description (English) |
productJapaneseDesc |
String | - | Server description (Japanese) |
productType2Code |
String | - | Server classification |
infraResourceTypeCode |
String | - | Infrastructure resource type |
infraResourceDetailTypeCode |
String | - | Infrastructure resource detailed type |
cpuCount |
String | - | Number of CPUs |
memorySize |
Integer | - | Memory size (byte) |
baseBlockStorageProductCode |
Integer | - | Default block storage type |
diskType2Code |
String | - | Disk type |
isChangeSpec |
Boolean | - | Whether server type can be changed
|
isSelected |
Boolean | - | Current usage status
|
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": {
"managerNodeProductList": [
{
"productCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
"productName": "[STAND] 2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productKoreanName": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productEnglishName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productJapaneseName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productDesc": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productKoreanDesc": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productEnglishDesc": "[STAND] vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productJapaneseDesc": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productType2Code": "STAND",
"infraResourceTypeCode": "VELST",
"infraResourceDetailTypeCode": null,
"cpuCount": "2",
"memorySize": 8589934592,
"baseBlockStorageProductCode": "SPBSTBSTBS000005",
"diskType2Code": "NET",
"isChangeSpec": true,
"isSelected": true
},
...
],
"dataNodeProductList": [
{
"productCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
"productName": "[STAND] 2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productKoreanName": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productEnglishName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productJapaneseName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productDesc": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productKoreanDesc": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productEnglishDesc": "[STAND] vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productJapaneseDesc": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productType2Code": "STAND",
"infraResourceTypeCode": "VELST",
"infraResourceDetailTypeCode": null,
"cpuCount": "2",
"memorySize": 8589934592,
"baseBlockStorageProductCode": "SPBSTBSTBS000005",
"diskType2Code": "NET",
"isChangeSpec": true,
"isSelected": true
},
...
],
"masterNodeProductList": [
{
"productCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
"productName": "[STAND] 2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productKoreanName": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productEnglishName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productJapaneseName": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productDesc": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productKoreanDesc": "2 vCPUs, 8 GB memory, 50 GB [SSD] disk",
"productEnglishDesc": "[STAND] vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productJapaneseDesc": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
"productType2Code": "STAND",
"infraResourceTypeCode": "VELST",
"infraResourceDetailTypeCode": null,
"cpuCount": "2",
"memorySize": 8589934592,
"baseBlockStorageProductCode": "SPBSTBSTBS000005",
"diskType2Code": "NET",
"isChangeSpec": true,
"isSelected": false
},
...
]
},
"requestId": "4d16abf0-****-****-****-1a1e60d5ee68"
}