クラスタの作成(IDを返す)

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタを作成します。レスポンスにクラスタインスタンス番号が返されます。

リクエスト

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

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

リクエストヘッダ

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文字以内で入力
  • 使用できない記号: '、"、`、₩、/、&、スペース
softwareProductCode String Required OSタイプコード
vpcNo Integer Required VPC番号
managerNodeSubnetNo Integer Required マネージャノードの Subnet番号
managerNodeProductCode String Required マネージャノードのサーバタイプコード
brokerNodeSubnetNo Integer Required ブローカーノードの Subnet番号
brokerNodeCount Integer Required ブローカーノード数
  • 3~10 (デフォルト: 3)
brokerNodeProductCode String Required ブローカーノードのサーバタイプコード
brokerNodeStorageSize Integer Required ブローカーノードのストレージ容量(GB)
  • 100~2000 (10GB単位)
  • ストレージタイプは SSDのみサポート

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/createCDSSClusterReturnServiceGroupInstanceNo' \
--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": "cluster002",
    "kafkaVersionCode": "3903006",
    "configGroupNo": 3**,
    "kafkaManagerUserName": "ncpadmin",
    "kafkaManagerUserPassword": "**********",
    "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
    "vpcNo": 4***,
    "managerNodeSubnetNo": 30***,
    "managerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
    "brokerNodeSubnetNo": 33***,
    "brokerNodeCount": 3,
    "brokerNodeProductCode": "SVR.VCDSS.HICPU.C002.M004.NET.SSD.B050.G002",
    "brokerNodeStorageSize": 100
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "serviceGroupInstanceNo": 1009*****
    },
    "requestId": "b1c51f69-****-****-****-9371949cc985"
}