Clusterの作成
    • PDF

    Clusterの作成

    • PDF

    記事の要約

    VPC環境で利用できます。

    入力された情報で新規クラスタを作成します。

    リクエスト

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

    メソッドURI
    POST/clusters

    リクエストヘッダ

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

    リクエスト構文

    リクエスト構文は次の通りです。

    {
      "name": "String",
      "clusterType": "String",
      "k8sVersion": "String",
      "loginKeyName": "String",
      "hypervisorCode": "String",
      "regionCode": "String",
      "zoneCode": "String",
      "zoneNo": "Integer",
      "publicNetwork": "Boolean",
      "kubeNetworkPlugin": "String",
      "vpcNo": "Integer",
      "subnetNoList": [
        "Integer"
      ],
      "subnetLbNo": "Integer",
      "lbPrivateSubnetNo": "Integer",
      "lbPublicSubnetNo": "Integer",
      "log": {
        "audit": "Boolean"
      },
      "kmsKeyTag": "String",
      "nodePool": [
        {
          "name": "String",
          "nodeCount": "Integer",
          "subnetNo": "Integer",
          "subnetNoList": [
            "Integer"
          ],
          "softwareCode": "String",
          "productCode": "String",
          "labels": [
            {
              "key": "String",
              "value": "String"
            }
          ],
          "taints": [
            {
              "key": "String",
              "value": "String",
              "effect": "String"
            }
          ],
          "serverSpecCode": "String",
          "storageSize": "Integer",
          "serverRoleId": "String"
        }
      ]
    }
    

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    nameStringRequiredクラスタ名
    • 英数字、記号の「-」のみ使用して3~30文字以内で入力、先頭文字は英字、末尾文字は英字または数字のみ使用可能
    clusterTypeStringRequiredクラスタのタイプ
    k8sVersionStringOptionalKubernetesバージョン
    loginKeyNameStringRequired認証キー名
    • 保有する認証キー名を入力
    hypervisorCodeStringOptionalハイパーバイザコード
    • XEN(デフォルト) | KVM
    regionCodeStringRequiredリージョンコード
    zoneCodeStringConditionalゾーンコード
    • zoneNoを入力しなかった場合、必須
    • getZoneListアクションを通じて確認
    zoneNoStringConditionalゾーン番号
    • zoneCodeを入力しなかった場合、必須
    • getZoneListアクションを通じて確認
    publicNetworkBooleanOptionalサブネットネットワークタイプ
    • true | false(デフォルト)
  • true: Public
  • false: Private
  • vpcNoIntegerRequiredクラスタを配置する VPC番号
    • コンソールまたはgetVpcListアクションを通じて確認
    subnetNoList[]ArrayRequiredサブネット番号リスト
    • getSubnetListアクションを通じて確認
    • publicNetworkが falseの場合、一般用の Private Subnetの Subnet IDを入力
    • publicNetworkが trueの場合、一般用の Public Subnetの Subnet IDを入力
    subnetLbNoIntegerConditional@deprecated ロードバランサ専用の Private Subnet番号
    lbPrivateSubnetNoIntegerConditionalクラスタに適用するロードバランサ専用の Private Subnet番号
    lbPublicSubnetNoIntegerRequiredクラスタに適用するロードバランサ専用の Public Subnet番号
    logObjectOptional
    log.auditBooleanOptionalAudit Logを設定
    • true | false (デフォルト)
    kmsKeyTagStringOptionalKey Management Serviceの Key Tag
    nodePool[]ArrayOptional追加するノードプールリスト
    nodePool[].nameStringOptionalノードプール名
    nodePool[].nodeCountIntegerOptionalノード数
    nodePool[].subnetNoIntegerOptional@deprecated サブネット番号
    nodePool[].subnetNoList[]ArrayOptionalサブネット番号
    • 有効な範囲: クラスタ subnetNoList
    nodePool[].softwareCodeStringOptionalサーバイメージコード
    nodePool[].productCodeStringOptionalサービスタイプ
    nodePool[].labels[]ArrayOptionalノードラベルリスト
    nodePool[].labels[].keyStringConditionalラベルのキー
    • nodePool[].labels入力時、必須
    • 英数字、記号の「-」、「_」、「.」 が入力可能で、文字列の先頭と末尾は英字または数字のみ使用
    nodePool[].labels[].valueStringConditionalラベルの値
    • nodePool[].labels入力時、必須
    • 英数字、記号の「-」、「_」、「.」 が入力可能で、文字列の先頭と末尾は英字または数字のみ使用
    nodePool[].taints[]ArrayOptionaltaintリスト
    nodePool[].taints[].keyStringConditionaltaintのキー
    • nodePool[].taints入力時、必須
    • 英数字、記号の「-」、「_」、「.」 が入力可能で、文字列の先頭と末尾は英字または数字のみ使用
    nodePool[].taints[].valueStringOptionaltaintの値
    • 英数字、記号の「-」、「_」、「.」 が入力可能で、文字列の先頭と末尾は英字または数字のみ使用
    nodePool[].taints[].effectStringConditionaltaintの効果
    • nodePool[].taints入力時、必須
    • NoSchedule |PreferNoSchedule|NoExecute
    nodePool[].serverSpecCodeStringOptionalサーバタイプ
    nodePool[].storageSizeIntegerOptionalストレージ容量
    • hypervisorCode KVMの場合にのみ使用
    • 有効範囲: 100(デフォルト)~2000GB
    nodePool[].serverRoleIdStringOptionalノードプールサーバのロールを付与するための ID

    リクエスト例

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

    curl --location --request POST 'https://nks.apigw.ntruss.com/vnks/v2/clusters' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'Content-Type: application/json'
    --data '{
        "name": "String",
        "clusterType": "String",
        "k8sVersion": "String",
        "loginKeyName": "String",
        "hypervisorCode": "String",
        "regionCode": "String",
        "zoneCode": "String",
        "zoneNo": "Integer",
        "publicNetwork": "Boolean",
        "kubeNetworkPlugin": "String",
        "vpcNo": "Integer",
        "subnetNoList": [
          "Integer"
        ],
        "subnetLbNo": "Integer",
        "lbPrivateSubnetNo": "Integer",
        "lbPublicSubnetNo": "Integer",
        "log": {
          "audit": "Boolean"
        },
        "nodePool": [
          {
            "name": "String",
            "nodeCount": "Integer",
            "subnetNo": "Integer",
            "subnetNoList": [
              "Integer"
            ],
            "softwareCode": "String",
            "productCode": "String",
            "labels": [
              {
                "key": "String",
                "value": "String"
              }
            ],
            "taints": [
              {
                "key": "String",
                "value": "String",
                "effect": "String"
              }
            ],
            "serverSpecCode": "String",
            "storageSize": "Integer",
            "serverRoleId": "String"
          }
        ]
    }'
    

    レスポンス

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

    レスポンス構文

    レスポンス構文は次の通りです。

    {
        "uuid": "String"
    }
    

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    uuidString-クラスタの UUID

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

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

    レスポンス例

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

    {
        "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****"
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.