changeFabricClusterDescription

VPC環境で利用できます。

Fabric Clusterの説明を更新します。

構文

changeFabricClusterDescription構文は次の通りです。

./ncloud vserver changeFabricClusterDescription \
    --fabricClusterNo <fabric-cluster-no> \
    [--fabricClusterDescription <fabric-cluster-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

changeFabricClusterDescriptionの実行時に指定できるオプションについて説明します。

必須オプション

changeFabricClusterDescriptionの必須オプションです。

オプション	タイプ	必須の有無	説明
`--fabricClusterNo`	String	Required	Fabric Cluster番号 getFabricClusterListを参照

任意オプション

changeFabricClusterDescriptionの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--fabricClusterDescription`	String	Optional	Fabric Clusterの説明(Byte) 0~1,000

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

例

Fabric Clusterの説明の変更リクエストが成功すると、クラスタの最新情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vserver changeFabricClusterDescription \
    --fabricClusterNo 13579246 \
    --fabricClusterDescription "Updated cluster description" \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "changeFabricClusterDescriptionResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13579246",
        "fabricClusterName": "test-cluster-01",
        "fabricClusterStatus": {
          "code": "RUN",
          "codeName": "実行中"
        },
        "fabricClusterDescription": "Updated cluster description",
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "vpcNo": "12345678",
        "fabricClusterPoolNo": "24680135",
        "fabricClusterPoolName": "gpu-cluster-pool-01",
        "fabricClusterPoolCode": "gpu-cluster-pool-01",
        "createDate": "2026-05-15T10:02:05+0900",
        "fabricClusterServerInstanceList": []
      }
    ],
    "requestId": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index