クラスタの作成(G3)

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタを作成します。

参考

KVMハイパーバイザタイプの第3世代サーバ専用の APIです。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
clusterName String Required クラスタ名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用不可
kafkaVersionCode Integer Required Kafkaバージョンコード
configGroupNo Integer Required Config Group番号
kafkaManagerUserName String Required CMAKアクセスアカウント ID
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 記号の「-」は連続使用不可
kafkaManagerUserPassword String Required CMAKアクセスアカウントのパスワード
  • 英数字、記号を組み合わせて8~20文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、スペース
hypervisorCode String Required ハイパーバイザコード
generationCode String Required サーバの世代コード
softwareProductCode String Required OSタイプコード
vpcName String Required VPC名
vpcNo Integer Required VPC番号
managerNodeSubnetName String Required マネージャノードの Subnet名
managerNodeSubnetNo Integer Required マネージャノードの Subnet番号
managerNodeProductCode String Required マネージャノードのサーバタイプコード
dataNodeSubnetName String Required ブローカーノードの Subnet名
dataNodeSubnetNo Integer Required ブローカーノードの Subnet番号
dataNodeCount Integer Required ブローカーノード数
  • 3~10 (デフォルト: 3)
dataNodeProductCode String Required ブローカーノードのサーバタイプコード
dataNodeStorageType2Code String Optional ブローカーノードストレージ接続タイプコード
  • NET (有効値)
dataNodeStorageInfraResourceDetailTypeCode String Optional ブローカーノードストレージタイプコード
  • CB1 (有効値)
dataNodeStorageSize Integer Required ブローカーノードのストレージ容量(GB)
  • 100~2000 (10GB単位)
serverSpecCode String Required サーバスペックコード
参考

リクエストボディのdataNodeはブローカーノードを意味します。

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/createKvmCluster' \
--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": "cluster01",
    "kafkaVersionCode": "3903006",
    "configGroupNo": 3**,
    "kafkaManagerUserName": "ncpadmin",
    "kafkaManagerUserPassword": "************",
    "hypervisorCode": "KVM",
    "generationCode": "G3",
    "softwareProductCode": "SW.VCDSS.OS.LNX64.ROCKY.08.G003",
    "vpcName": "test-vpc2",
    "vpcNo": 4***,
    "managerNodeSubnetName": "sb1",
    "managerNodeSubnetNo": 30***,
    "managerNodeProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G003",
    "dataNodeSubnetName": "sb2",
    "dataNodeSubnetNo": 33***,
    "dataNodeCount": 3,
    "dataNodeProductCode": "SVR.VCDSS.STAND.C002.M008.NET.SSD.B050.G003",
    "dataNodeStorageType2Code": "SSD",
    "dataNodeStorageInfraResourceDetailTypeCode": "CB1",
    "dataNodeStorageSize": 100,
    "serverSpecCode": "cdss.s2-g3"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "71643b2e-****-****-****-59f75d13f864"
}