VPC環境で利用できます。
Ncloud Kubernetes Serviceは、アプリケーションのコンテナ化、デプロイ、スケーリング、そして管理を自動化するオープンソースプラットフォームです。Ncloud Kubernetes Serviceサービスは、Kubernetes環境制御および管理機能関連の APIを RESTfulの形式で提供します。
Ncloud Kubernetes Serviceの共通設定
Ncloud Kubernetes Service APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://nks.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名 |
Content-Type |
Required | リクエストデータの形式
|
レスポンス
共通レスポンス形式を説明します。
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 403 | - | ForbiddenException | Sub Accountで APIを呼び出す時、権限不十分により発生 |
| 409 | - | ConflictException | クラスタやノードプールを処理中に変更リクエストした時に発生 |
参考
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
Ncloud Kubernetes Service API
Ncloud Kubernetes Serviceサービスで提供する APIの説明は次の通りです。
| API | 説明 |
|---|---|
| Clusterリストの照会 | クラスタリストを照会 |
| Clusterの照会 | クラスタ情報を照会 |
| Clusterの作成 | クラスタを新規作成 |
| Clusterのバージョンアップグレード | クラスタの Kubernetesを新規のバージョンにアップグレード |
| Cluster Audit Logの設定 | Cloud Log Analyticsサービスを利用してログを収集するかどうかを設定 |
| Cluster Subnetの追加 | クラスタにサブネットを追加 |
| Cluster OIDCの設定 | クラスタに OIDC認証機能を追加 |
| Cluster OIDCの照会 | クラスタの OIDC設定情報を照会 |
| Cluster IPアドレス ACLの設定 | クラスタの IPアドレス ACLを設定 |
| Cluster IPアドレス ACLの照会 | クラスタに設定した IPアドレス ACL情報を照会 |
| Cluster LB Subnetの変更 | クラスタに設定したロードバランサのサブネットが削除された場合、新しいロードバランサのサブネットを設定 |
| Cluster返却保護の設定 | クラスタの返却保護をするかどうかを設定 |
| Clusterシークレット暗号化の設定 | 作成されたクラスタのシークレット暗号化を設定 |
| Cluster認証モードの設定 | クラスタの認証モードを更新 |
| Cluster IAMアクセスリストの照会 | クラスタの IAMアクセスリスト情報を照会 |
| Cluster IAMアクセスの照会 | クラスタの IAMアクセス情報を照会 |
| Cluster IAMアクセスの作成 | クラスタの IAMアクセスを作成 |
| Cluster IAMアクセスの更新 | クラスタの IAMアクセス情報を更新 |
| Cluster IAMアクセスの削除 | クラスタの IAMアクセスを削除 |
| Clusterの削除 | クラスタを削除 |
| WorkerNodeの照会 | クラスタ内に作成されたワーカーノードリストを照会 |
| WorkerNodeの削除 | クラスタ内に作成されたワーカーノードを削除 |
| NodePoolの照会 | クラスタ内にワーカーノードを作成するために設定したノードプールのリストを照会 |
| NodePoolの作成 | クラスタ内に、ワーカーノードの数、スペックなどを設定するノードプールを作成 |
| NodePoolの変更 | ノードプールで固定されたノード数を変更したり、オートスケールの使用有無を設定 |
| NodePool Subnetの変更 | 別途 Subnetを割り当てたノードプールに限り、割り当てられた Subnet帯域を変更 |
| NodePool Labelの変更 | ノードプールのラベルを変更 |
| NodePool Taintの変更 | ノードプールの Taintを変更 |
| NodePoolのアップグレード | クラスタに登録されているノードプールのバージョンをアップグレード |
| NodePoolの削除 | ノードプールと、これに属するノードをクラスタから削除 |
| Kubeconfigの照会 | クラスタの kubeconfig設定ファイルを照会 |
| k8sサポートバージョンの照会 | クラスタを作成できる k8sバージョンを照会 |
| サーバイメージの照会 | クラスタを作成する際に利用できるサーバイメージタイプを照会 |
| サーバスペックの照会 | クラスタまたはノードプールを作成する際に利用できるサーバスペックを照会 |
Ncloud Kubernetes Service関連リソース
Ncloud Kubernetes Service APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Ncloud Kubernetes Service APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Ncloud Kubernetes Serviceサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Ncloud Kubernetes Serviceサービスの使用方法
- Ncloud Kubernetes Serviceご利用ガイド: NAVERクラウドプラットフォームコンソールで Ncloud Kubernetes Serviceを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポートの有無に関するご利用ガイド
- 料金の紹介、特徴、詳細機能: Ncloud Kubernetes Serviceの料金体系、特徴、詳細機能のサマリー
- サービスのお知らせ: Ncloud Kubernetes Serviceに関するお知らせ
- よくある質問: Ncloud Kubernetes Serviceに関するよくあるご質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ