ノードリストの照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタのノードリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterNodeList/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.contractNo Integer - 契約番号
result.createdDate Object - クラスタの作成日時
result.createdDate.formattedDate String - クラスタの作成日
  • yyyy-MM-dd形式
result.createdDate.formattedDateTime String - クラスタの作成日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
result.createdDate.utc Integer - クラスタの作成日時(ミリ秒)
  • Unix Timestamp形式
result.productCode String - OS商品コード
result.regionNo Integer - リージョン番号
result.serviceGroupInstanceNo Integer - クラスタインスタンス番号
result.serviceGroupInstanceTypeCode String - クラスタインスタンスタイプ
result.serviceGroupName String - クラスタ名
result.statusCode String - クラスタの状態
result.vpcNo Integer - VPC番号
result.computeList Array - ノードリスト
requestId String - リクエスト ID
  • UUID形式

result.computeList

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

フィールド タイプ 必須の有無 説明
computeInstanceNo Integer - ノードのサーバインスタンス番号
computeInstanceProductCode String - ノードのサーバタイプコード
computeInstanceStatus String - ノードサーバの状態
cpuCount Integer - CPU数
createdYmdt Object - ノードの作成日時
createdYmdt.formattedDate String - ノードの作成日
  • yyyy-MM-dd形式
createdYmdt.formattedDateTime String - ノードの作成日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
createdYmdt.utc Integer - ノードの作成日時(ミリ秒)
  • Unix Timestamp形式
hostName String - ノードサーバ名
macAddress String - ノードサーバの MACアドレス
memorySize Integer - ノードサーバのメモリ容量(Byte)
nodeRoleCode String - ノードタイプコード
  • M | D | DO | MO
    • M: マネージャノード
    • D、DO: データノード
    • MO: マスターノード
operationYmdt Object - サーバの作動日時
operationYmdt.formattedDate String - サーバの作動日
  • yyyy-MM-dd形式
operationYmdt.formattedDateTime String - サーバの作動日時
  • yyyy-MM-dd HH:mm:ss SSSSSS形式
operationYmdt.utc Integer - サーバの作動日時(ミリ秒)
  • Unix Timestamp形式
osInfo String - OSのバージョン
privateIp String - ノードサーバの内部 IPアドレス
regionCode String - リージョンコード
regionName String - リージョン名
regionNo String - リージョン番号
serviceGroupInstanceNo Integer - クラスタインスタンス番号
uuid String - ノードサーバ ID
  • UUID形式
vpcName String - VPC名
vpcNo Integer - VPC番号
subnetNo Integer - Subnet番号
subnetName String - Subnet名
zoneName String - ゾーン名
zoneNo Integer - ゾーン番号

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "contractNo": 19146995,
        "createdDate": {
            "formattedDate": "2025-03-20",
            "formattedDateTime": "2025-03-20 17:04:37 000283",
            "utc": 1742457877283
        },
        "productCode": "SW.VELST.OS.LNX64.ROCKY.0808.B050",
        "regionNo": 1,
        "serviceGroupInstanceNo": 1037*****,
        "serviceGroupInstanceTypeCode": "ELASTICSEARCH",
        "serviceGroupName": "cluster006",
        "statusCode": "CREAT",
        "vpcNo": 9****,
        "computeList": [
            {
                "computeInstanceNo": 1037*****,
                "computeInstanceProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
                "computeInstanceStatus": "running",
                "cpuCount": 2,
                "createdYmdt": {
                    "formattedDate": "2025-03-20",
                    "formattedDateTime": "2025-03-20 17:04:38 000446",
                    "utc": 1742457878446
                },
                "hostName": "cluster006-m-6tvf",
                "macAddress": "F2:**:**:**:**:40",
                "memorySize": 8589934592,
                "nodeRoleCode": "M",
                "operationYmdt": {
                    "formattedDate": "2025-03-20",
                    "formattedDateTime": "2025-03-20 17:09:06 000267",
                    "utc": 1742458146267
                },
                "osInfo": "Rocky Linux 8.8",
                "privateIp": "**.**.**.**",
                "regionCode": "KR",
                "regionName": "Korea",
                "regionNo": "1",
                "serviceGroupInstanceNo": 1037*****,
                "uuid": "11b1a5d8-****-****-****-13647592550e",
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "subnetNo": 20****,
                "subnetName": "s1-hd-pri | KR-2 | Private",
                "zoneName": "KR-2",
                "zoneNo": 3
            },
            ...
        ]
    },
    "requestId": "bb3354b1-****-****-****-5bee2500c24f"
}