VPC環境で利用できます。
クラスタに登録されているノードプールのバージョンをアップグレードします。アップグレード中にノードが追加されたり、サービス不可状態に陥る事態に備えて値を設定することもできます。
参考
ノードプールをアップグレードする前に、サービスに影響を与えかねない要素をチェックしてください。チェックする要素の詳細は、Ncloud Kubernetes Serviceご利用ガイドをご参照ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PATCH | /clusters/{uuid}/node-pool/{instanceNo}/upgrade |
リクエストヘッダ
Ncloud Kubernetes Service APIで共通して使用されるヘッダの詳細は、Ncloud Kubernetes Serviceの共通ヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
uuid |
String | Required | クラスタの UUID
|
instanceNo |
Integer | Required | ノードプールのインスタンス番号 |
リクエストクエリパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
k8sVersion |
String | Required | アップグレードする Kubernetesバージョン
|
maxSurge |
Integer | Optional | アップグレード中に追加可能なノード数
|
maxUnavailable |
Integer | Optional | アップグレード中にサービス不可状態になっても構わないノード数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/upgrade?k8sVersion={version}&maxSurge=2&maxUnavailable=0' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"uuid": "string",
"instanceNo": "integer"
}
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
uuid |
String | - | クラスタの UUID |
instanceNo |
Integer | - | ノードプールのインスタンス番号 |
レスポンスステータスコード
Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Kubernetes Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"uuid": "1a1111a1-4d44-99b9-88c8-9e99a99e9e99",
"instanceNo": 23323233
}