クラスタの照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (韓国リージョン)
GET /api/sgn-v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (シンガポールリージョン)
GET /api/jpn-v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (日本リージョン)

リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfo/1008*****' \
--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.clusterStatus String - クラスタの状態
result.createDate String - クラスタの作成日時
result.serviceGroupInstanceNo String - クラスタインスタンス番号
result.vpcNo Integer - VPC番号
result.softwareProductCode String - OSタイプコード
result.searchEngineVersionCode String - Search Engineバージョンコード
result.searchEngineUserName String - Search Engineアクセス ID
result.searchEnginePort String - Search Engineポート情報
result.searchEngineDashboardPort String - ダッシュボードポート番号
result.isDualManager Boolean - マネージャノードを冗長化するかどうか
  • true | false
    • true: 冗長化
    • false: 冗長化しない
result.managerNodeCount Integer - マネージャノード数
result.managerNodeSubnetNo Integer - マネージャノードの Subnet番号
result.managerNodeProductCode String - マネージャノードのサーバタイプコード
result.managerNodeAcgId Integer - マネージャノードの ACG ID
result.managerNodeAcgName String - マネージャノードのACG名
result.dataNodeCount Integer - データノード数
result.dataNodeSubnetNo Integer - データノードの Subnet番号
result.dataNodeProductCode String - データノードのサーバタイプコード
result.dataNodeAcgId Integer - データノードの ACG ID
result.dataNodeAcgName String - データノードのACG名
result.dataNodeStorageSize String - データノード別ストレージ容量(GB)
result.isMasterOnlyNodeActivated Boolean - マスターノードを有効化するかどうか
  • true | false
    • true: 有効化
    • false: 無効化
result.masterNodeCount Integer - マスターノード数
result.masterNodeSubnetNo Integer - マスターノードの Subnet番号
result.masterNodeProductCode String - マスターノードのサーバタイプコード
result.masterNodeAcgId Integer - マスターノードの ACG ID
result.masterNodeAcgName String - マスターノードのACG名
result.loginKeyName String - 認証キー名
result.managerNodeInstanceNoList Array - マネージャノードのインスタンス番号リスト
result.clusterNodeList Array - ノードリスト
requestId String - リクエスト ID
  • UUID形式

result.clusterNodeList

result.clusterNodeListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
computeInstanceName String - ノードサーバ名
computeInstanceNo Integer - ノードのサーバインスタンス番号
privateIp String - ノードサーバの内部 IPアドレス
serverStatus String - ノードサーバの状態
nodeType String - ノードタイプ
subnet String - Subnet名

レスポンスステータスコード

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "clusterName": "cluster-kvm000",
        "clusterStatus": "running",
        "createDate": "2025-03-28T10:12:04.488+09:00",
        "serviceGroupInstanceNo": "1008*****",
        "vpcNo": 4***,
        "softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.08.G003",
        "searchEngineVersionCode": "2140",
        "searchEngineUserName": "userid",
        "searchEnginePort": "9200",
        "searchEngineDashboardPort": "5601",
        "isDualManager": true,
        "managerNodeCount": 2,
        "managerNodeSubnetNo": 3****,
        "managerNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
        "managerNodeAcgId": 58***,
        "managerNodeAcgName": "searchengine-m-1o0xct",
        "dataNodeCount": 3,
        "dataNodeSubnetNo": 3****,
        "dataNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
        "dataNodeAcgId": 58***,
        "dataNodeAcgName": "searchengine-do-1o0xct",
        "dataNodeStorageSize": "200",
        "isMasterOnlyNodeActivated": true,
        "masterNodeCount": 3,
        "masterNodeSubnetNo": 3****,
        "masterNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
        "masterNodeAcgId": 58***,
        "masterNodeAcgName": "searchengine-mo-1o0xct",
        "loginKeyName": "loginkey01",
        "managerNodeInstanceNoList": [
            1008*****,
            1008*****
        ],
        "clusterNodeList": [
            {
                "computeInstanceName": "cluster-kvm000-m-24c0",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.14",
                "serverStatus": "running",
                "nodeType": "Manager",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-m-24c1",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.15",
                "serverStatus": "running",
                "nodeType": "Manager",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-mo-24c2",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.16",
                "serverStatus": "running",
                "nodeType": "Master",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-mo-24c3",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.17",
                "serverStatus": "running",
                "nodeType": "Master",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-mo-24c4",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.18",
                "serverStatus": "running",
                "nodeType": "Master",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-do-24c5",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.19",
                "serverStatus": "running",
                "nodeType": "Data",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-do-24c6",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.20",
                "serverStatus": "running",
                "nodeType": "Data",
                "subnet": "sb2 | KR-2 | Private"
            },
            {
                "computeInstanceName": "cluster-kvm000-do-24c7",
                "computeInstanceNo": 1008*****,
                "privateIp": "10.0.20.21",
                "serverStatus": "running",
                "nodeType": "Data",
                "subnet": "sb2 | KR-2 | Private"
            }
        ]
    },
    "requestId": "f4a41d71-****-****-****-753100085283"
}