Available in VPC
Get changeable server specifications for each cluster node of Cloud Data Streaming Service.
This is a dedicated API for third-generation servers of the KVM hypervisor type.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/cluster/getServerSpecListForSpecChange/{serviceGroupInstanceNo} (Korea Region) |
POST | /api/sgn-v1/cluster/getServerSpecListForSpecChange (Singapore Region) |
POST | /api/jpn-v1/cluster/getServerSpecListForSpecChange (Japan Region) |
Request headers
For information about the headers common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
serviceGroupInstanceNo |
Integer | Required | Cluster instance number
|
Request example
The request example is as follows:
curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getServerSpecListForSpecChange' \
--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 '{
"serviceGroupInstanceNo": "1009*****"
}'
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 | - | Broker node server type list: Server type information |
requestId |
String | - | ID for the request
|
The dataNode
in the response body refers to the broker node, for your reference.
Server type information
The following describes the server type information.
Field | Type | Required | Description |
---|---|---|---|
serverSpecCode |
String | - | Server specification code |
serverSpecTypeCode |
String | - | Server classification |
serverSpecDescription |
String | - | Server description |
productCode |
String | - | Server type code |
hypervisorCode |
String | - | Hypervisor code |
generationCode |
String | - | Server generation code |
cpuArchitectureCode |
String | - | CPU architecture type |
cpuCount |
Integer | - | Number of CPUs |
memorySize |
Integer | - | Memory size (GB) |
blockStorageMaxCount |
Integer | - | Maximum number of assignable storage |
networkInterfaceMaxCount |
Integer | - | Maximum number of assignable network interfaces |
zoneNoList |
Array | - | Zone number list |
computeInstanceDetailTypeCode |
String | - | Detailed server type code |
isChangeSpec |
Boolean | - | Whether server type can be changed
|
isSelected |
Boolean | - | Current usage status
|
memorySizeToBytes |
Integer | - | Memory size (byte) |
Response status codes
For information about the HTTP status codes common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service response status codes.
Response example
The response example is as follows:
{
"code": 0,
"message": "SUCCESS",
"result": {
"managerNodeProductList": [
{
"serverSpecCode": "cdss.c2-g3",
"serverSpecTypeCode": "HICPU",
"serverSpecDescription": "[HICPU] vCPU 2EA, Memory 4GB",
"productCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G003",
"hypervisorCode": "KVM",
"generationCode": "G3",
"cpuArchitectureCode": "X86_64",
"cpuCount": 2,
"memorySize": 4,
"blockStorageMaxCount": 20,
"networkInterfaceMaxCount": 3,
"zoneNoList": [
2,
3
],
"computeInstanceDetailTypeCode": null,
"isChangeSpec": true,
"isSelected": true,
"memorySizeToBytes": 4294967296
},
...
],
"dataNodeProductList": [
{
"serverSpecCode": "cdss.c2-g3",
"serverSpecTypeCode": "HICPU",
"serverSpecDescription": "[HICPU] vCPU 2EA, Memory 4GB",
"productCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G003",
"hypervisorCode": "KVM",
"generationCode": "G3",
"cpuArchitectureCode": "X86_64",
"cpuCount": 2,
"memorySize": 4,
"blockStorageMaxCount": 20,
"networkInterfaceMaxCount": 3,
"zoneNoList": [
2,
3
],
"computeInstanceDetailTypeCode": null,
"isChangeSpec": true,
"isSelected": true,
"memorySizeToBytes": 4294967296
},
...
]
},
"requestId": "3ad7ea22-****-****-****-9d0ee4c9ab2f"
}