ニフクラAPI (Catalog: CreateResourceGroup)

CreateResourceGroup

処理概要

リソースグループを新規作成します。

リクエストURL

POST /v1/resource-groups

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
name	string	名前 使用可能文字: 半角英数小文字またはハイフン（先頭と末尾を除く）40文字以内	○
description	string	メモ 使用可能文字: UTF-8で全角半角255文字以内
template	string	テンプレート 指定可能なテンプレートはListTemplatesで取得可能	○

応答フィールド

フィールド (項目)	型	説明
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 -XPOST https://catalog.api.nifcloud.com/v1/resource-groups
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
  "name": "my-resource-group",
  "description": "my-resource-group description",
  "template": "anthos"
}
'

  

応答サンプル

    {
  "name": "my-resource-group",
  "description": "my-resource-group description",
  "template": "anthos",
  "configuration": null,
  "status": "unprovisioned",
  "createTime": "2023-11-01T12:34:56Z"
}