クラスタの作成

Prev Next

VPC環境で利用できます。

Search Engineクラスタを作成します。

リクエスト

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

メソッド URI
POST /api/v2/cluster/createSearchEngineCluster (韓国リージョン)
POST /api/sgn-v2/cluster/createSearchEngineCluster (シンガポールリージョン)
POST /api/jpn-v2/cluster/createSearchEngineCluster (日本リージョン)

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
clusterName String Required クラスタ名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用不可
searchEngineVersionCode String Required Search Engineバージョン
searchEngineDashboardPort String Required ダッシュボードポート番号
  • 1025~65534
  • 使用できない番号: 9090、9200、9300
searchEngineUserName String Required Search Engine管理者アカウント ID
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用不可
searchEngineUserPassword String Required Search Engine管理者アカウントパスワード
  • 英数字、記号を組み合わせて8~20文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、スペース
softwareProductCode String Required OSタイプコード
vpcNo Integer Required VPC番号
managerNodeSubnetNo Integer Required マネージャノードの Subnet番号
isDualManager Boolean Optional マネージャノードを冗長化するかどうか
  • true (デフォルト) | false
    • true: 冗長化
    • false: 冗長化しない
managerNodeProductCode String Required マネージャノードのサーバタイプコード
isMasterOnlyNodeActivated Boolean Optional マスターノードを有効化するかどうか
  • true | false
    • true: 有効化
    • false: 無効化
masterNodeSubnetNo Integer Conditional マスターノードの Subnet番号
masterNodeCount Integer Conditional マスターノード数
  • 3 (デフォルト) | 5
  • isMasterOnlyNodeActivatedがtrueの場合、必ず入力
masterNodeProductCode String Conditional マスターノードのサーバタイプコード
dataNodeSubnetNo Integer Required データノードの Subnet番号
dataNodeCount Integer Required データノード数
  • 3~10 (デフォルト: 3)
dataNodeProductCode String Required データノードのサーバタイプコード
dataNodeStorageSize Integer Required データノードのストレージ容量(GB)
  • 100~2000 (10GB単位)
  • ストレージタイプは SSDのみサポート
loginKeyName String Required 認証キー名

リクエスト例

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

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster' \
--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 '{
    "clusterName": "cluster006",
    "searchEngineVersionCode": "290",
    "searchEngineDashboardPort": "1025",
    "searchEngineUserName": "ncpadmin",
    "searchEngineUserPassword": "*********",
    "softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.0808.B050",
    "vpcNo": 9****,
    "managerNodeSubnetNo": 20****,
    "managerNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
    "isMasterOnlyNodeActivated": true,
    "masterNodeSubnetNo": 20****,
    "masterNodeCount": 3,
    "masterNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
    "dataNodeSubnetNo": 20****,
    "dataNodeCount": 3,
    "dataNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
    "dataNodeStorageSize": 100,
    "loginKeyName": "loginkey01"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.serviceGroupInstanceNo Integer - クラスタインスタンス番号
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "serviceGroupInstanceNo": 1037*****
    },
    "requestId": "1455f9ef-****-****-****-a7e80275e16b"
}