VPC環境で利用できます。
Search Engineクラスタのノード別サーバスペックを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v2/cluster/getNodeSpecDetail/{serviceGroupInstanceNo} (韓国リージョン) |
| GET | /api/sgn-v2/cluster/getNodeSpecDetail/{serviceGroupInstanceNo} (シンガポールリージョン) |
| GET | /api/jpn-v2/cluster/getNodeSpecDetail/{serviceGroupInstanceNo} (日本リージョン) |
リクエストヘッダ
Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceGroupInstanceNo |
Integer | Required | クラスタインスタンス番号
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getNodeSpecDetail/1037*****' \
--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.clusterName |
String | - | クラスタ名 |
result.serviceGroupInstanceNo |
Integer | - | クラスタインスタンス番号 |
result.softwareProductCode |
String | - | クラスタ OSタイプコード |
result.managerNodeProductName |
String | - | マネージャノードサーバタイプ |
result.managerNodeProductCode |
String | - | マネージャノードのサーバタイプコード |
result.dataNodeProductName |
String | - | データノードサーバタイプ |
result.dataNodeProductCode |
String | - | データノードのサーバタイプコード |
result.masterNodeProductName |
String | - | マスターノードのサーバタイプ |
result.masterNodeProductCode |
String | - | マスターノードのサーバタイプコード |
requestId |
String | - | リクエスト ID
|
レスポンスステータスコード
Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": 0,
"message": "SUCCESS",
"result": {
"clusterName": "cluster006",
"serviceGroupInstanceNo": 1037*****,
"softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.0808.B050",
"managerNodeProductName": "vCPU 2EA, Memory 8GB, [SSD] Disk 50GB",
"managerNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
"dataNodeProductName": "vCPU 2EA, Memory 8GB, [SSD] Disk 50GB",
"dataNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
"masterNodeProductName": "vCPU 2EA, Memory 8GB, [SSD] Disk 50GB",
"masterNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002"
},
"requestId": "5baeadde-****-****-****-035067020ab5"
}