リクエスト

リクエスト URL

POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster [KR]
POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/createSearchEngineCluster [SGN]
POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/createSearchEngineCluster [JPN]

リクエストヘッダ

ヘッダ名	説明
x-ncp-apigw-timestamp	- 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルで発行された Access Key ID `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key IDと Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content typeは application/jsonに指定 `Content-Type: application/json`

リクエストパラメータ

パラメータ	タイプ	必須の有無	説明
clusterName	String	Y	- クラスタ名英字(小文字)、数字、連続していないハイフン「-」でのみ構成先頭文字は英字、末尾文字は英字または数字のみ使用可能
searchEngineVersionCode	String	Y	- 使用する Search Engineのバージョン getSearchEngineVersionListアクションを通じて取得可能
searchEngineDashboardPort	String	Y	- Search Engine Dashboard(Kibanaまたは Opensearch Dashboard)の http port 9090、9200、9300portは使用不可 1025-65534の間の portのみ使用可能
searchEngineUserName	String	Y	- Search Engine Dashboardアクセス ID 英字(小文字)、数字、連続していないハイフン「-」でのみ構成先頭文字は英字、末尾文字は英字または数字のみ使用可能
searchEngineUserPassword	String	Y	- Search Engineアクセスパスワード 8文字以上、英字の大文字と小文字、記号、数字を必ずそれぞれ1文字以上含めること
softwareProductCode	String	Y	- 使用する OSタイプ getOsProductListアクションを通じて取得可能
vpcNo	Integer	Y	- 使用する VPC No getVpcListアクションを通じて取得可能
isDualManager	Boolean	Y	マネージャノードを冗長化するかどうか
managerNodeSubnetNo	Integer	Y	- マネージャノードが位置する Subnet No getSubnetList
managerNodeProductCode	String	Y	- マネージャノードのハードウェアスペック getNodeProductList
isMasterOnlyNodeActivated	Boolean	Y	マスター専用ノードの有効化有無
masterNodeSubnetNo	Integer	N	- マスターノードが位置する Subnet No getSubnetList
masterNodeProductCode	String	N	- マスターノードのハードウェアスペック getNodeProductList
masterNodeCount	Integer	N	- マスターノード数 3台または5台
dataNodeSubnetNo	Integer	Y	- データノードが位置する Subnet No getSubnetList
dataNodeProductCode	String	Y	- データノードのハードウェアスペック getNodeProductList
dataNodeCount	Integer	Y	- データノード数最小3台以上、最大10台まで作成可能
dataNodeStorageSize	Integer	Y	- データノードのストレージ容量最小100GB、最大2000GBまで10GB単位で選択
loginKeyName	String	Y	- マネージャノードに SSH接続する際に使用する認証キー名 getLoginKeyList

リクエスト例

POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw

{
  "clusterName": "testcluster",
  "searchEngineVersionCode": "133",
  "searchEngineDashboardPort" : "5601",
  "searchEngineUserName": "test,
  "searchEngineUserPassword": "qwe123!@#",
  "softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
  "vpcNo": 1236,
  "managerNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "managerNodeSubnetNo": 1300,
  "dataNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "dataNodeCount": 3,
  "dataNodeSubnetNo": 1301,
  "dataNodeStorageSize": 100,
  "loginKeyName": "testkey",
  "isDualManager": true,
  "isMasterOnlyNodeActivated" : false
}

curl -X POST "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" \
-d \
'{
  "clusterName": "testcluster",
  "searchEngineVersionCode": "133",
  "searchEngineDashboardPort" : "5601",
  "searchEngineUserName": "test,
  "searchEngineUserPassword": "qwe123!@#",
  "softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
  "vpcNo": 1236,
  "managerNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "managerNodeSubnetNo": 1300,
  "dataNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "dataNodeCount": 3,
  "dataNodeSubnetNo": 1301,
  "dataNodeStorageSize": 100,
  "loginKeyName": "testkey",
  "isDualManager": true,
  "isMasterOnlyNodeActivated" : false
}'

レスポンスパラメータ

public class CreateClusterResponseVo {
        private Integer serviceGroupInstanceNo;
}

フィールド

パラメータ名	タイプ	説明
serviceGroupInstanceNo	Integer	作成されたクラスタのserviceGroupInstanceNo

レスポンス例

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "serviceGroupInstanceNo": 1484582
    },
    "requestId": "2ade3f23-4ef1-48da-9385-f6740a4ad078"
}

この記事は役に立ちましたか?

リクエスト
レスポンスパラメータ
フィールド
- レスポンス例

タグ

Search Engine Service