updateFabricCluster

Prev Next

VPC環境で利用できます。

Fabric Clusterを更新します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
fabricClusterNo String Required Fabric Cluster番号
fabricClusterName String Required Fabric Cluster名
  • 英小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英小文字、末尾文字は英小文字または数字のみ使用
fabricClusterDescription String Optional Fabric Clusterの説明(Byte)
  • 0~1000
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/updateFabricCluster
?regionCode=KR
&fabricClusterNo=13**
&fabricClusterName=test-***
&fabricClusterDescription=updated-description
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "updateFabricClusterResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13**",
        "fabricClusterName": "test-***",
        "fabricClusterStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "fabricClusterDescription": "updated-description",
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "vpcNo": "***84",
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterPoolCode": "test-***",
        "createDate": "2025-12-12T13:36:17+0900",
        "fabricClusterServerInstanceList": [
          {
            "serverInstanceNo": "****59627",
            "serverName": "test-***",
            "serverInstanceStatus": {
              "code": "RUN",
              "codeName": "サーバ RUN状態"
            },
            "serverInstanceOperation": {
              "code": "NULL",
              "codeName": "サーバ NULL OP"
            },
            "serverInstanceStatusName": "running"
          }
        ]
      }
    ],
    "requestId": "e7039be4-3b54-4713-a03c-69dc3dcdd4e7",
    "returnCode": "0",
    "returnMessage": "success"
  }
}