updateFabricClusterServerInstances

Prev Next

VPC環境で利用できます。

Fabric Clusterに含まれたサーバインスタンスリストを変更します。サーバリストが変更されるまで数分から数十分かかります。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/updateFabricClusterServerInstances
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
fabricClusterNo String Required Fabric Cluster番号
clusterModeServerInstanceNoList.N String Optional クラスタモードに設定するサーバインスタンス番号リスト
  • Fabric Clusterに設定された Fabric Cluster Poolで作成されたサーバのみ設定可能
  • getServerInstanceListを参照
    • 既存のクラスタモードサーバの照会: fabricClusterNoとfabricClusterMode=CLUSTERで絞り込み
    • 追加可能なシングルモードサーバの照会: fabricClusterPoolNoとfabricClusterMode=SINGLEで絞り込み
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json
参考

リクエストクエリパラメータの入力時、下記の内容をご確認ください。

  • updateFabricClusterServerInstances APIは、既存のクラスタモード設定をリクエストしたリストで更新します。そのため、既存の設定済みサーバインスタンスを維持したい場合は、そのサーバインスタンス番号も含めてリクエストしてください。
  • clusterModeServerInstanceNoListを空のリストでリクエストするか、省略した場合、既存のクラスタモード設定はすべて解除されます。

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/updateFabricClusterServerInstances
?regionCode=KR
&fabricClusterNo=13**
&clusterModeServerInstanceNoList.1=1**
&clusterModeServerInstanceNoList.2=2**
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
updateFabricClusterServerInstancesResponse Object - レスポンス結果
updateFabricClusterServerInstancesResponse.requestId String - リクエスト ID
  • UUID形式
updateFabricClusterServerInstancesResponse.returnCode String - レスポンスコード
updateFabricClusterServerInstancesResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
  "updateFabricClusterServerInstancesResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13**",
        "fabricClusterName": "test-***",
        "fabricClusterStatus": {
          "code": "SETUP",
          "codeName": "設定中"
        },
        "fabricClusterDescription": "test",
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "vpcNo": "***84",
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterPoolCode": "test-***",
        "createDate": "2025-12-12T13:36:17+0900",
        "fabricClusterServerInstanceList": []
      }
    ],
    "requestId": "8b4841e9-0ca6-4e0e-84ef-054d42de4464",
    "returnCode": "0",
    "returnMessage": "success"
  }
}