ニフクラAPI (Catalog: DeleteAnthosUserCluster)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>Catalog> API> DeleteAnthosUserCluster

DeleteAnthosUserCluster

処理概要

Anthos(GKE Enterprise) のユーザークラスターを削除します。

リクエストURL

DELETE /v1/resource-groups/{ResourceGroupName}/anthos/user-clusters/{ClusterName}

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
ResourceGroupName	string	削除対象のクラスターが属しているリソースグループ名	○
ClusterName	string	削除対象のクラスター名	○

応答フィールド

フィールド (項目)	型	説明
name	string	クラスター名
version	string	Anthos(GKE Enterprise) バージョン
keyName	string	SSHキー名
initialAccountingType	string	初期料金プラン値: pay-per-use monthly
anthosServiceMeshConfig	object
␣enabled	boolean	Anthos Service Meshの有効・無効
␣version	string	Anthos Service Meshのバージョン指定可能な値はGetAnthosServerConfigで確認可能 Anthos Service Meshが有効かつ指定されていない場合はGetAnthosServerConfigのdefaultConfig.serviceMeshVersionの値が入る
cloudControllerManagerConfig	object
␣useExternalCloudProvider	boolean	Cloud Controller Manager用クラスター設定の有効・無効
controlPlaneLoadBalancer	object
␣type	string	タイプ値: elastic-load-balancer
␣vip	string	ロードバランサー仮想IPアドレス
␣systemIpAddresses	string[]	システムIPアドレス typeがelastic-load-balancerのときのみ返却
␣elasticLoadBalancer	object
␣␣region	string	リージョン
␣␣availabilityZone	string	ゾーン
␣␣id	string	ユニークID
␣␣name	string	マルチロードバランサー名
␣␣dnsName	string	VIPネットワーク IPアドレス
␣␣networkInterfaces[]	object[]
␣␣␣networkId	string	ネットワークID
␣␣␣ipAddress	string	IPアドレス
␣␣␣isVipNetwork	boolean	VIPネットワークフラグ待ち受けポートが設定されるネットワーク
␣␣␣systemIpAddresses	string[]	システムIPアドレス
controlPlane	object
␣name	string	ノードプール名
␣region	string	リージョン
␣availabilityZone	string	ゾーン
␣instanceType	string	サーバータイプ値: h2-large16 h2-large24 h2-large32 h2-extra-large16 h2-extra-large24 h2-extra-large32 h2-extra-large48 h2-double-large16 h2-double-large24 h2-double-large32 h2-double-large48 h2-double-large64 h2-double-large96 h2-triple-large32 h2-triple-large48 h2-triple-large64 h2-triple-large96 h2-triple-large128 h2-quad-large64 h2-quad-large96 h2-quad-large128 h2-septa-large128
␣volumeType	string	ディスクタイプ値: standard-flash-storage-a standard-flash-storage-b high-speed-flash-storage-a high-speed-flash-storage-b
␣volumeSize	integer	ディスクサイズ値: 100
␣nodeCount	integer	ノード数
␣instances[]	object[]
␣␣region	string	リージョン
␣␣availabilityZone	string	ゾーン
␣␣instanceId	string	サーバー名
␣␣instanceUniqueId	string	ユニークID
␣␣instanceType	string	サーバータイプ
␣␣securityGroupName	string	ファイアウォールグループ名
␣␣networkInterfaces[]	object[]
␣␣␣networkId	string	ネットワークID
␣␣␣ipAddress	string	IPアドレス
␣␣volumes[]	object[]
␣␣␣region	string	リージョン
␣␣␣availabilityZone	string	ゾーン
␣␣␣volumeId	string	ディスク名
␣␣␣volumeUniqueId	string	ユニークID
␣␣␣type	string	ディスクタイプ
␣␣␣size	integer	ディスクサイズ
nodePools[]	object[]
␣name	string	ノードプール名
␣region	string	リージョン
␣availabilityZone	string	ゾーン
␣instanceType	string	サーバータイプ値: h2-large16 h2-large24 h2-large32 h2-extra-large16 h2-extra-large24 h2-extra-large32 h2-extra-large48 h2-double-large16 h2-double-large24 h2-double-large32 h2-double-large48 h2-double-large64 h2-double-large96 h2-triple-large32 h2-triple-large48 h2-triple-large64 h2-triple-large96 h2-triple-large128 h2-quad-large64 h2-quad-large96 h2-quad-large128 h2-septa-large128
␣volumeType	string	ディスクタイプ値: standard-flash-storage-a standard-flash-storage-b high-speed-flash-storage-a high-speed-flash-storage-b
␣volumeSize	integer	ディスクサイズ値: 100
␣nodeCount	integer	ノード数
␣instances[]	object[]
␣␣region	string	リージョン
␣␣availabilityZone	string	ゾーン
␣␣instanceId	string	サーバー名
␣␣instanceUniqueId	string	ユニークID
␣␣instanceType	string	サーバータイプ
␣␣securityGroupName	string	ファイアウォールグループ名
␣␣networkInterfaces[]	object[]
␣␣␣networkId	string	ネットワークID
␣␣␣ipAddress	string	IPアドレス
␣␣volumes[]	object[]
␣␣␣region	string	リージョン
␣␣␣availabilityZone	string	ゾーン
␣␣␣volumeId	string	ディスク名
␣␣␣volumeUniqueId	string	ユニークID
␣␣␣type	string	ディスクタイプ
␣␣␣size	integer	ディスクサイズ
status	string	ステータス値: running failed warning provisioning configuring deleting

リクエストサンプル

    curl -XDELETE https://catalog.api.nifcloud.com/v1/resource-groups/my-resource-group/anthos/user-clusters/my-cluster
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'

応答サンプル

    {
  "name": "my-cluster",
  "version": "1.16.0",
  "keyName": "mykey",
  "initialAccountingType": "pay-per-use",
  "anthosServiceMeshConfig": {
    "enabled": true,
    "version": "1.18.2-asm.0"
  },
  "cloudControllerManagerConfig": {
    "useExternalCloudProvider": true
  },
  "controlPlaneLoadBalancer": {
    "type": "elastic-load-balancer",
    "vip": "192.168.1.1",
    "systemIpAddresses": [
      "192.168.1.2",
      "192.168.1.3"
    ],
    "elasticLoadBalancer": {
      "region": "east-1",
      "availabilityZone": "east-11",
      "id": "elb-xxxxxxxx",
      "name": "mycplbxxxxx",
      "dnsName": "192.168.1.1",
      "networkInterfaces": [
        {
          "networkId": "net-xxxxxxxx",
          "ipAddress": "192.168.1.1",
          "isVipNetwork": true,
          "systemIpAddresses": [
            "192.168.1.2",
            "192.168.1.3"
          ]
        }
      ]
    }
  },
  "controlPlane": {
    "name": "my-cluster",
    "region": "east-1",
    "availabilityZone": "east-11",
    "instanceType": "h2-large16",
    "volumeType": "standard-flash-storage-a",
    "volumeSize": 100,
    "nodeCount": 1,
    "instances": [
      {
        "region": "east-1",
        "availabilityZone": "east-11",
        "instanceId": "mycpsvxxxxx",
        "instanceUniqueId": "i-xxxxxxxx",
        "instanceType": "h2-large16",
        "securityGroupName": "mycpfwxxxxx",
        "networkInterfaces": [
          {
              "networkId": "net-COMMON_GLOBAL",
              "ipAddress": "192.0.2.1"
          },
          {
            "networkId": "net-xxxxxxxx",
            "ipAddress": "192.168.10.1"
          }
        ],
        "volumes": [
          {
            "region": "east-1",
            "availabilityZone": "east-11",
            "volumeId": "mycpdkxxxxx",
            "volumeUniqueId": "vol-xxxxxxxx",
            "type": "standard-flash-storage-a",
            "size": 100
          }
        ]
      }
    ]
  },
  "nodePools": [
    {
      "name": "my-pool",
      "region": "east-1",
      "availabilityZone": "east-11",
      "instanceType": "h2-large16",
      "volumeType": "standard-flash-storage-a",
      "volumeSize": 100,
      "nodeCount": 1,
      "instances": [
        {
          "region": "east-1",
          "availabilityZone": "east-11",
          "instanceId": "mywksvxxxxx",
          "instanceUniqueId": "i-xxxxxxxx",
          "instanceType": "h2-large16",
          "securityGroupName": "mywkfwxxxxx",
          "networkInterfaces": [
            {
                "networkId": "net-COMMON_GLOBAL",
                "ipAddress": "192.0.2.2"
            },
            {
              "networkId": "net-xxxxxxxx",
              "ipAddress": "192.168.10.2"
            }
          ],
          "volumes": [
            {
              "region": "east-1",
              "availabilityZone": "east-11",
              "volumeId": "mywkdkxxxxx",
              "volumeUniqueId": "vol-xxxxxxxx",
              "type": "standard-flash-storage-a",
              "size": 100
            }
          ]
        }
      ]
    }
  ],
  "status": "deleting"
}