APIを呼び出してACK Edgeクラスターを作成する - Container Service for Kubernetes

CreateCluster操作を呼び出して、Container Service for Kubernetes (ACK) Edgeクラスターを作成できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエスト構文

POST /clusters HTTP/1.1
Content-Type:application/json
{
  "name" : "String",
  "cluster_type" : "String",
  "disable_rollback" : Boolean,
  "timeout_mins" : Long,
  "kubernetes_version" : "String",
  "runtime" : {
    "name" : "String",
    "version" : "String"
  },
  "region_id" : "String",
  "key_pair" : "String",
  "login_password" : "String",
  "num_of_nodes" : Long,
  "profile" : "String",
  "logging_type" : "String",
  "snat_entry" : Boolean,
  "vswitch_ids" : [ "String" ],
  "worker_system_disk_category" : "String",
  "worker_system_disk_size" : Long,
  "container_cidr" : "String",
  "cloud_monitor_flags" : Boolean,
  "endpoint_public_access" : Boolean,
  "service_cidr" : "String",
  "addons" : [ {
    "name" : "String",
    "config" : "String",
    "disabled" : Boolean
  } ],
  "tags" : [ {
    "key" : "String",
    "value" : "String"
  } ],
  "vpcid" : "String",
  "worker_data_disks" : [ {
    "category" : "String",
    "size" : Long,
    "encrypted" : "String",
    "auto_snapshot_policy_id" : "String"
  } ],
  "deletion_protection" : Boolean,
  "node_cidr_mask" : "String",
  "worker_instance_types" : [ "String" ],
  "worker_instance_charge_type" : "String",
  "security_group_id" : "String",
  "is_enterprise_security_group" : Boolean,
  "rds_instances" : [ "String" ]
}

リクエストパラメーター

表 1. リクエストボディパラメータ

パラメーター	型	必須 / 任意	例	説明
name	String	対象	demo-edge-cluster	クラスターの名前。名前は1 ~ 63文字で、数字、文字、ハイフン (-) を使用できます。名前をハイフン (-) で始めることはできません。
cluster_type	String	対象	ManagedKubernetes	クラスターのタイプ。値を`ManagedKubernetes`に設定し、ACK Edgeクラスターを作成します。
disable_rollback	Boolean	非対象	true	このパラメーターは非推奨です。クラスターの作成に失敗したときにロールバックを実行するかどうかを指定します。有効な値： `true`: クラスターの作成に失敗した場合、ロールバックを実行します。 `false`: クラスターの作成に失敗した場合、ロールバックは実行されません。デフォルト値: `false`。
timeout_mins	Long	非対象	60	このパラメーターは非推奨です。リソースを作成する必要があるタイムアウト期間。単位：分デフォルト値：60。
kubernetes_version	String	任意	1.30.1-aliyun.1	クラスターの Kubernetes のバージョンです。 Container ServiceでサポートされているKubernetesバージョンは、オープンソースKubernetesでサポートされているKubernetesバージョンと同じです。最新のKubernetesバージョンを指定することを推奨します。このパラメーターを設定しない場合、最新のKubernetesバージョンが使用されます。 ACKコンソールで、最新の3つのKubernetesバージョンのクラスターを作成できます。 API操作を呼び出すことで、以前のバージョンのKubernetesのクラスターを作成できます。 ACKでサポートされているKubernetesバージョンの詳細については、「Kubernetesバージョンのサポート」をご参照ください。
ランタイム	ランタイムの配列	非対象	{"name": "`containerd` ", "version": "1.6.20"}	使用するコンテナーランタイム。 `containerd`および`docker`ランタイムがサポートされています。このパラメータは、次の情報を指定します。 `name`: コンテナーランタイムの名前。 `version`: コンテナランタイムのバージョン。
region_id	String	対象	cn-beijing	クラスターのリージョン ID。
キー_ペア	String	対象	デモキー	このパラメーターは非推奨です。キーペアの名前。このパラメーターまたは`login_password`を設定する必要があります。
login_password	String	対象	HelloWorld123	このパラメーターは非推奨です。 SSHログインのパスワード。このパラメーターまたは`key_pair`を設定する必要があります。パスワードの長さは8 ~ 30文字で、大文字、小文字、数字、および特殊文字のうち少なくとも3つの種類が含まれている必要があります。
num_of_nodes	Long	対象	1	このパラメーターは非推奨です。ワーカーノードの数です。有効値: 0~100。
プロフィール	String	対象	Edge	クラスターがACK Edgeクラスターかどうかを指定します。デフォルト値: Edge 。
logging_type	String	任意	SLS	クラスターのSimple Log Serviceを有効にするかどうかを指定します。値を`SLS`に設定します。このパラメーターは、ACKサーバーレスクラスターに対してのみ有効です。
snat_entry	Boolean	非対象	true	クラスターをデプロイする仮想プライベートクラウド (VPC) のSNATルールを設定するかどうかを指定します。 VPCがインターネットにアクセスできる場合、値を`false`に設定します。 VPCがインターネットへのアクセスを提供しない場合、次の値が有効です。 `true`の: SNATルールを設定します。これにより、クラスターはVPCからインターネットにアクセスできます。 `false`: SNATルールは設定されません。この場合、クラスターはインターネットにアクセスできません。クラスターにデプロイされたアプリケーションがインターネットにアクセスする必要がある場合は、値を`true`に設定することを推奨します。デフォルト値: `false`。
vswitch_ids	文字列の配列	対象	vsw-2ze48rkq464rsdts1 ****	vSwitchのID。 1〜3つのvSwitchを指定できます。
worker_system_disk_カテゴリ	String	対象	cloud_efficiency	このパラメーターは非推奨です。ワーカーノードに使用するシステムディスクの種類。有効な値： `cloud_efficiency`: ウルトラディスク。 `cloud_ssd`: 標準SSD。デフォルト値: `cloud_ssd`。
worker_system_disk_サイズ	Long	対象	100	このパラメーターは非推奨です。ワーカーノードに使用するシステムディスクのサイズ。単位：GiB 有効な値: 40〜500 このパラメータの値は、40以上で、画像サイズ以上でなければなりません。デフォルト値: `120`。
container_cidr	String	任意	172.20.0.0	ポッドのCIDRブロック。このCIDRブロックは、クラスターがデプロイされているVPCのCIDRブロックと重複することはできません。 VPCがシステムによって自動的に作成される場合、ポッドのデフォルトのCIDRブロックは172.16.0.0/16です。重要このパラメーターは、クラスターがネットワークプラグインとしてFlannelを使用する場合に必要です。クラスターがネットワークプラグインとしてTerwayを使用している場合、このパラメーターはオプションです。
cloud_monitor_フラグ	Boolean	非対象	true	このパラメーターは非推奨です。 CloudMonitor エージェントをインストールするかどうかを指定します。有効な値： `true`: CloudMonitorエージェントをインストールします。 `false`: CloudMonitorエージェントをインストールしません。デフォルト値: `false`。
endpoint_public_アクセス	Boolean	非対象	true	APIサーバーのインターネットアクセスを有効にするかどうかを指定します。有効な値： `true`: APIサーバーのインターネットアクセスを有効にします。 `false`: APIサーバーのインターネットアクセスを無効にします。 APIサーバは、内部ネットワーク内でのみアクセス可能である。デフォルト値: `true`。重要 ACK Edgeクラスターでは、エッジノードはインターネットを介してクラウド内の制御プレーンと対話します。したがって、ACK Edgeクラスターを作成するときに、APIサーバーのインターネットアクセスを有効にする必要があります。
service_cidr	String	対象	172.21.0.0	サービスのCIDRブロック。このCIDRブロックは、ポッドのCIDRブロックまたはクラスターをデプロイするVPCのCIDRブロックと重複することはできません。 VPCがシステムによって自動的に作成される場合、サービスのデフォルトのCIDRブロックは172.19.0.0/20です。
アドオン	アドオンの配列	非対象	[{"name":"flannel","config":"},{" name ":" logtail-ds-docker "," config ":" },{ "name":"alibaba-log-controller","config":"{" IngressDashboardEnabled ":" false "}"}]	クラスターにインストールするコンポーネントです。パラメーターの説明： `name`: required このパラメータは、コンポーネントの名前を指定します。 `config`: オプション。このパラメーターが空の場合、設定は必要ありません。 `無効化`: オプション。自動インストールを無効にするかどうかを指定します。ネットワークプラグイン: 必須です。サポートされているネットワークプラグインはFlannelとTerwayです。クラスターのプラグインの1つを選択します。 Flannelプラグインを [{"name":"flannel","config":"" "}] の形式で指定します。 [{"name": "Terway-eniip","config": "" "}] の形式でterwayプラグインを指定します。ボリュームプラグイン: オプション。このパラメーターは、使用するボリュームプラグインを指定します。 `Container Storage Interface (CSI)` プラグインがサポートされています。 `CSI`プラグインを次の形式で指定します: [{"name": "csi-plugin","config": "},{" name ":" csi-provisioner "," config ":" ""}] 。 Log Serviceコンポーネント: オプション。説明 Simple Log Serviceが無効になっている場合、クラスター監査機能は使用できません。既存のSimple Log Serviceプロジェクトを使用するには、次の形式でコンポーネントを指定します。[{"name": "logtail-ds","config": "{\" IngressDashboardEnabled\":\" true\",\" sls_project_name\":\"}"}] 。 Simple Log Serviceプロジェクトを作成するには、次の形式でコンポーネントを指定します: [{"name": "logtail-ds","config": "{\" IngressDashboardEnabled\":\" true\"}"}] 。 Ingressコントローラ: オプション。デフォルトでは、nginx-ingress-controllerコンポーネントはACK専用クラスターにインストールされます。 nginx-ingress-controllerをインストールしてインターネットアクセスを有効にするには、[{"name":"nginx-Ingress-controller","config":"{\" IngressSlbNetworkType\":\" Internet \"}"}] の形式でingressコントローラーを指定します。 nginx-ingress-controllerをインストールしない場合は、Ingressコントローラを [{"name": "nginx-ingress-controller","config": "" "," disabled ": true}] の形式で指定します。イベントセンター (オプション) イベントセンター機能はデフォルトで有効化されています。イベントセンターを使用して、イベントを保存およびクエリし、アラートルールを設定できます。イベントセンターに関連付けられている Logstore は、90 日間無料で使用できます。詳細については、「イベントセンターの作成と使用」をご参照ください。イベントセンター機能を有効にするには、次の形式でコンポーネントを指定します。[{"name":"ack-node-problem-detector","config":"{\" sls_project_name\":\" your_sls_project_name\"}"}] 。
tags	タグの配列	非対象	[{"key": "env", "value": "prod"}]	クラスターに追加するラベル。 key: ラベルのキー。 value: ラベルの値。
vpcid	String	対象	vpc-2zeik9h3ahvv2zz95 ****	クラスターをデプロイするVPC。クラスターの作成時にVPCを指定する必要があります。説明 `vpc_id`と`vswitch_ids`の両方を空のままにするか、vswitch_idsパラメーターで指定されたvswitchがvpc_idパラメーターで指定されたvpcに属していることを確認します。
worker_data_ディスク	data_diskの配列	非対象		このパラメーターは非推奨です。ワーカーノードにマウントされているデータディスクの構成。構成には、ディスクタイプとディスクサイズが含まれます。
deletion_protection	Boolean	非対象	true	クラスターの削除保護を有効にするかどうかを指定します。削除保護が有効になっている場合、ACKコンソールまたはAPI操作を呼び出してクラスターを削除することはできません。有効な値： `true`: クラスターの削除保護を有効にします。この方法では、ACKコンソールまたはAPI操作を呼び出してクラスターを削除することはできません。 `false`: クラスターの削除保護を無効にします。このようにして、ACKコンソールまたはAPI操作を呼び出すことで、クラスターを削除できます。デフォルト値: `false`。
node_cidr_mask	String	任意	25	各ノードに割り当てることができるIPアドレスの最大数。この数は、指定されたポッドCIDRブロックによって決まります。このパラメーターは、クラスターがFlannelプラグインを使用している場合にのみ有効です。デフォルト値: `25`。
worker_instance_types	文字列の配列	対象	ecs.n4.large	このパラメーターは非推奨です。ワーカーノードのElastic Compute Service (ECS) インスタンスタイプ。少なくとも1つのインスタンスタイプを指定する必要があります。詳細については、「インスタンスファミリーの概要」をご参照ください。説明インスタンスタイプは、優先度の高い順にリストされます。システムが最も高い優先度のインスタンスタイプでワーカーノードを作成できなかった場合、システムは次に高い優先度のインスタンスタイプでワーカーノードを作成しようとします。
worker_instance_charge_type	String	対象	PrePaid	このパラメーターは非推奨です。ワーカーノードの課金方法。有効な値： `PrePaid`: サブスクリプション。 `PostPaid`: 従量課金。デフォルト値：PostPaid。
security_group_id	String	任意	sg-bp1bdue0qc1g7k ****	クラスターに使用する既存のセキュリティグループのID。このパラメーターまたは`is_enterprise_security_group`を設定する必要があります。クラスター内のノードは、指定されたセキュリティグループに自動的に追加されます。
is_enterprise_security_グループ	Boolean	非対象	true	高度なセキュリティグループを作成するかどうかを指定します。このパラメーターは、`security_group_id`が空の場合にのみ有効です。説明基本セキュリティグループを使用するには、クラスター内のノード数とTerwayを使用するポッド数の合計が2,000を超えないようにします。したがって、クラスターがTerwayネットワークプラグインを使用している場合は、クラスターに高度なセキュリティグループを指定することを推奨します。 `true`: 高度なセキュリティグループを作成します。 `false`: 高度なセキュリティグループを作成しません。デフォルト値: `true`。
rds_instances	rds_instances	非対象	rm-2zev748xi27xc ****	このパラメーターは非推奨です。 ApsaraDB RDSインスタンスの名前。
cluster_spec	String	任意	ack.pro.small	ACK管理クラスターのタイプ。有効な値： `ack.pro.small`: ACK Edge Proクラスター。 `ack.standard`: ACK Edge Basicクラスターデフォルト値: `ack.standard` このパラメーターを空のままにすると、ACK Edge Basicクラスターが作成されます。詳細については、「ACK Edge Proクラスターの概要」をご参照ください。
resource_group_id	String	任意	rg-acfm3mkrure ****	クラスターが属するリソースグループのID。このパラメーターを使用して、異なるクラスターを分離できます。

レスポンス構文

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "request_id" : "String",
  "task_id" : "String"
}

レスポンスパラメーター

表 2. 応答ボディパラメータ

パラメーター	タイプ	例	説明
cluster_id	String	cb95aa626a47740afbf6aa099b650 ****	クラスター ID
request_id	String	687C5BAA-D103-4993-884B-C35E4314A1E1	リクエスト ID。
task_id	String	T-5a54309c80282e39ea00002f	タスク ID。

例

リクエストの例

POST /clusters 
<Common request headers>
{
    "name":"ACK Edge cluster",
    "cluster_type":"ManagedKubernetes",
    "disable_rollback":true,
    "timeout_mins":60,
    "kubernetes_version":"1.14.8-aliyunedge.1",
    "region_id":"cn-zhangjiakou",
    "snat_entry":true,
    "cloud_monitor_flags":true,
    "endpoint_public_access":true,
    "deletion_protection":true,
    "node_cidr_mask":"25",
    "tags":[
        {
            "key":"tag-k",
            "value":"tag-v"
        }
    ],
    "addons":[
        {
            "name":"logtail-ds-docker"
        },
        {
            "name":"alibaba-log-controller",
            "config":"{\"IngressDashboardEnabled\":\"false\"}"
        },
        {
            "name":"flannel"
        },
        {
            "name":"alicloud-monitor-controller"
        }
    ],
    "profile":"Edge",            // Specifies that the cluster is an ACK Edge cluster. 
    "logging_type" : "SLS",
    "worker_instance_types":[
        "ecs.hfc6.large"
    ],
    "runtime":{                       // The configuration of the container runtime. 
        "name":"containerd",              // The name of the container runtime. 
        "version":"1.6.20"          // The version of the container runtime. 
    },
    "num_of_nodes":1,
    "worker_system_disk_category":"cloud_ssd",
    "worker_system_disk_size":40,
    "worker_data_disks":[
        {
            "category":"cloud_efficiency",
            "size":"40",
            "encrypted":"false",
            "auto_snapshot_policy_id":"",
        }
    ],
    "worker_instance_charge_type":"PostPaid",
    "vpcid":"vpc-8vb435kr467tnfj42****",
    "container_cidr":"172.20.0.0/16",
    "service_cidr":"172.21.0.0/20",
    "vswitch_ids":[
        "vsw-8vbhdhn461i65p32g****"
    ],
    "login_password":"Hello1234",
    "key_pair": "sin-name",
    "security_group_id":"sg-8vb7grbyvlb10j0i****",
    "is_enterprise_security_group":true,
    "rds_instances": ["rm-xx","rm-xx"]
}

成功レスポンスの例

XML 形式

<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>

JSON 形式

{
    "cluster_id": "cb95aa626a47740afbf6aa099b650****",
    "task_id": "T-5a54309c80282e39ea00002f",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。