ニフクラAPI (Catalog: ListResourceGroups)

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

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

ニフクラユーザーガイド

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

ListResourceGroups

処理概要

リソースグループの情報一覧を取得します。

リクエストURL

GET /v1/resource-groups

指定するパラメーター

なし

応答フィールド

フィールド (項目)	型	説明
resourceGroups[]	object[]
␣name	string	名前
␣description	string	メモ
␣template	string	テンプレート
␣configuration	object
␣␣anthos	object
␣␣␣regions	string[]	インフラリソースが存在しているリージョン
␣␣␣availabilityZones	string[]	インフラリソースが存在しているゾーン
␣␣␣resourceNamePrefix	string	リソース名プレフィックス
␣␣␣deploymentModel	string	デプロイメントモデル値: standalone multi hybrid
␣␣␣networkConfig	object
␣␣␣␣networkId	string	プライベートLANのネットワークID
␣␣␣googleCloudConfig	object
␣␣␣␣serviceAccount	object
␣␣␣␣␣projectId	string	プロジェクトID
␣␣␣␣␣clientEmail	string	クライアントメールアドレス
␣␣␣␣␣clientId	string	クライアントID
␣␣␣␣location	string	Google Cloudロケーション
␣␣␣adminWorkstation	object
␣␣␣␣region	string	リージョン
␣␣␣␣availabilityZone	string	ゾーン
␣␣␣␣instanceType	string	サーバータイプ値: h2-medium4 h2-medium8 h2-medium16 h2-medium24 h2-large h2-large8 h2-large16 h2-large24 h2-large32 h2-extra-large8 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
␣␣␣␣keyName	string	SSHキー名
␣␣␣␣initialAccountingType	string	初期料金プラン値: pay-per-use monthly
␣␣␣␣instance	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	ディスクサイズ
␣␣␣adminCluster	object
␣␣␣␣name	string	クラスター名
␣␣␣␣version	string	Anthos(GKE Enterprise) バージョン
␣␣␣␣keyName	string	SSHキー名
␣␣␣␣initialAccountingType	string	初期料金プラン値: pay-per-use monthly
␣␣␣␣anthosServiceMeshConfig	object
␣␣␣␣␣enabled	boolean	Cloud Service Meshの有効・無効
␣␣␣␣␣version	string	Cloud Service Meshのバージョン指定可能な値はGetAnthosServerConfigで確認可能 Cloud 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
␣␣␣userClusters[]	object[]
␣␣␣␣name	string	クラスター名
␣␣␣␣version	string	Anthos(GKE Enterprise) バージョン
␣␣␣␣keyName	string	SSHキー名
␣␣␣␣initialAccountingType	string	初期料金プラン値: pay-per-use monthly
␣␣␣␣anthosServiceMeshConfig	object
␣␣␣␣␣enabled	boolean	Cloud Service Meshの有効・無効
␣␣␣␣␣version	string	Cloud Service Meshのバージョン指定可能な値はGetAnthosServerConfigで確認可能 Cloud 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
␣status	string	ステータス値: provisioned failed agent-offline unprovisioned provisioning configuring deleting
␣createTime	string	作成日時

リクエストサンプル

    curl -XGET https://catalog.api.nifcloud.com/v1/resource-groups
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'

応答サンプル

    {
  "resourceGroups": [
    {
      "name": "my-resource-group",
      "description": "my-resource-group description",
      "template": "anthos",
      "configuration": {
        "anthos": {
          "regions": [
            "east-1"
          ],
          "availabilityZones": [
            "east-11"
          ],
          "resourceNamePrefix": "my",
          "deploymentModel": "standalone",
          "networkConfig": {
            "networkId": "net-COMMON_PRIVATE"
          },
          "googleCloudConfig": {
            "serviceAccount": {
                "projectId": "my-google-project",
                "clientEmail": "my-service-account@my-google-project.iam.gserviceaccount.com",
                "clientId": "0000000000000000000000"
            },
            "location": "asia-northeast1"
          },
          "adminWorkstation": {
            "region": "east-1",
            "availabilityZone": "east-11",
            "instanceType": "h2-medium4",
            "volumeType": "standard-flash-storage-a",
            "volumeSize": 100,
            "keyName": "mykey",
            "initialAccountingType": "pay-per-use",
            "instance": {
              "region": "east-1",
              "availabilityZone": "east-11",
              "instanceId": "myawsvxxxxx",
              "instanceUniqueId": "i-xxxxxxxx",
              "instanceType": "h2-medium4",
              "securityGroupName": "myawfwxxxxx",
              "networkInterfaces": [
                {
                  "networkId": "net-COMMON_GLOBAL",
                  "ipAddress": "192.0.2.1"
                },
                {
                  "networkId": "net-COMMON_PRIVATE",
                  "ipAddress": "192.0.2.2"
                }
              ],
              "volumes": [
                {
                  "region": "east-1",
                  "availabilityZone": "east-11",
                  "volumeId": "myawdkxxxxx",
                  "volumeUniqueId": "vol-xxxxxxxx",
                  "type": "standard-flash-storage-a",
                  "size": 100
                }
              ]
            }
          },
          "adminCluster": {
              "name": "my-cluster",
              "version": "1.16.0",
              "keyName": "sshkey",
              "initialAccountingType": "pay-per-use",
              "anthosServiceMeshConfig": {
                "enabled": false,
                "version": ""
              },
              "cloudControllerManagerConfig": {
                "useExternalCloudProvider": false
              },
              "controlPlaneLoadBalancer": {
                "type": "elastic-load-balancer",
                "vip": "",
                "systemIpAddresses": [],
                "elasticLoadBalancer": {
                  "region": "east-1",
                  "availabilityZone": "east-11",
                  "id": "elb-xxxxxxxx",
                  "name": "mycplbxxxxx",
                  "dnsName": "192.0.2.3",
                  "networkInterfaces": [
                    {
                      "networkId": "net-COMMON_PRIVATE",
                      "ipAddress": "192.0.2.3",
                      "isVipNetwork": true,
                      "systemIpAddresses": []
                    }
                  ]
                }
              },
              "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.4"
                      },
                      {
                        "networkId": "net-COMMON_PRIVATE",
                        "ipAddress": "192.0.2.5"
                      }
                    ],
                    "volumes": [
                      {
                        "region": "east-1",
                        "availabilityZone": "east-11",
                        "volumeId": "mycpdkxxxxx",
                        "volumeUniqueId": "vol-xxxxxxxx",
                        "type": "standard-flash-storage-a",
                        "size": 100
                      }
                    ]
                  }
                ]
              },
              "nodePools": [
                {
                  "name": "pool01",
                  "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.6"
                        },
                        {
                          "networkId": "net-COMMON_PRIVATE",
                          "ipAddress": "192.0.2.7"
                        }
                      ],
                      "volumes": [
                        {
                          "region": "east-1",
                          "availabilityZone": "east-11",
                          "volumeId": "mywkdkxxxxx",
                          "volumeUniqueId": "vol-xxxxxxxx",
                          "type": "standard-flash-storage-a",
                          "size": 100
                        }
                      ]
                    }
                  ]
                }
              ],
              "status": "running"
          },
          "userClusters": []
        }
      },
      "status": "provisioned",
      "createTime": "2023-11-01T12:34:56Z"
    }
  ]
}