クラスタリストの照会

VPC環境で利用できます。

Search Engineクラスタリストを照会します。

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfoList?pageNo=1&pageSize=20&inputText=cluster&vpcName=myvpc' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

result.allowedClusters

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

result.disallowedClusters

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

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "currentPage": 1,
        "isFirst": true,
        "isLast": true,
        "pageSize": 20,
        "totalCount": 5,
        "totalPage": 1,
        "allowedClusters": [
            {
                "clusterName": "cluster000",
                "dataNodeType": "[STAND] 2vCPU, 8GB Mem",
                "dataNodeProductName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "dataNodeCount": 3,
                "clusterStatus": "running",
                "searchEngineStatus": "green",
                "searchEngineVersion": "OpenSearch 2.14.0",
                "softwareProductName": "CentOS 7.8 (64-bit)",
                "createDate": "2025-03-20 11:31:48",
                "managerNodeType": "[STAND] 2vCPU, 8GB Mem",
                "managerNodeCount": 2,
                "dataStorageVolumeSize": 322122547200,
                "managerNodeAccessControlGroupSequence": 249484,
                "managerNodeAccessControlGroupName": "searchengine-m-1pr1dg",
                "dataNodeAccessControlGroupSequence": 249483,
                "dataNodeAccessControlGroupName": "searchengine-do-1pr1dg",
                "searchEnginePort": "9200",
                "searchEngineDashboardPort": "5601",
                "loginKeyName": "loginkey01",
                "serviceGroupInstanceNo": "1037*****",
                "searchEngineUserName": "userid",
                "memberNo": "279****",
                "vpcName": "myvpc",
                "vpcNo": 9****,
                "managerNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "managerNodeSubnetNo": 20****,
                "dataNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "dataNodeSubnetNo": 20****,
                "isPluginInstalled": true,
                "isDualManager": true,
                "accessKeyId": "******************",
                "isMasterOnlyNodeActivated": true,
                "masterNodeAccessControlGroupSequence": 249485,
                "masterNodeAccessControlGroupName": "searchengine-mo-1pr1dg",
                "masterNodeSubnetName": "s1-hd-pri | KR-2 | Private",
                "masterNodeSubnetNo": 20****,
                "masterNodeType": "[STAND] 2vCPU, 8GB Mem",
                "masterNodeProductName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB",
                "masterNodeCount": 3
            },
            ...
        ],
        "disallowedClusters": [
            {
                "clusterName": "cluster007",
                "clusterStatus": "running",
                "searchEngineStatus": "green",
                "serviceGroupInstanceNo": "1037*****"
            },
            ...
        ]
    },
    "requestId": "ecc71c59-****-****-****-a46b472f04c4"
}