CreateNfvInstGroup

POST/zstack/v1/nfvinstgroup/group

Operation ID

CreateNfvInstGroup

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

paramsstructure
ObjectRequired
paramsstructure request body object.
- name
  StringRequired
  The resource name.
- description
  String
  Optional. The detailed description of the resource.
- instType
  StringRequired
  The inst type.
- funcType
  StringRequired
  The func type.
- monitorIps
  List
  Optional.
- nfvInstOfferingUuid
  StringRequired
  The NFV inst offering UUID.
- frontEndL3NetworkUuid
  String
  Optional.
- backendL3NetworkUuids
  List
  Optional.
- resourceUuid
  String
  Optional. The resource Uuid.
- tagUuids
  List
  Optional. The list of tag Uuids.
- netOsDistro
  String
  Optional.
- baseOsDistro
  String
  Optional.
- vipUuid
  String
  Optional. VIP UUID
- ipv6VipUuid
  String
  Optional.
- primaryStorageUuid
  String
  Optional. The primary storage Uuid.
- primaryStoragePoolUuid
  String
  Optional.
- clusterUuid
  String
  Optional. The cluster Uuid.
- zoneUuid
  String
  Optional. The zone Uuid.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

success
booleanRequired
Whether the operation succeeded.
error
ErrorCodeRequired
Error code, null if operation succeeds, non-null if operation fails, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
NfvInstGroupInventoryRequired
See inventory.
- name
  StringRequired
  The resource name.
- uuid
  StringRequired
  The resource Uuid.
- description
  String
  Optional. The detailed description of the resource.
- nfvInstOfferingUuid
  StringRequired
  The NFV inst offering UUID.
- configVersion
  intRequired
  The config version.
- netOsDistro
  StringRequired
  The net OS distro.
- baseOsDistro
  StringRequired
  The base OS distro.
- statusDetail
  StringRequired
  The status detail.
- createDate
  TimestampRequired
  The creation date.
- lastOpDate
  TimestampRequired
  The last operation date.
- vipUuid
  StringRequired
  VIP UUID
- ipv6VipUuid
  StringRequired
  The ipv 6 VIP UUID.
- primaryStorageUuid
  StringRequired
  The primary storage Uuid.
- primaryStoragePoolUuid
  StringRequired
  The primary storage pool UUID.
- clusterUuid
  StringRequired
  The cluster UUID.
- zoneUuid
  StringRequired
  The zone UUID.
- instType
  InstTypeRequired
  See instType.
  KVM
  InstTypeRequired
  The KVM.
  CONTAINER
  InstTypeRequired
  The CONTAINER value.
  HOST
  InstTypeRequired
  The HOST value.
- funcType
  FuncTypeRequired
  See funcType.
  OVN_SDN_CONTROLLER
  FuncTypeRequired
  The OVN_SDN_CONTROLLER value.
- status
  NfvInstGroupStatusRequired
  See status.
  Initializing
  NfvInstGroupStatusRequired
  The Initializing value.
  Healthy
  NfvInstGroupStatusRequired
  The Healthy value.
  Degraded
  NfvInstGroupStatusRequired
  The Degraded value.
  Operating
  NfvInstGroupStatusRequired
  The Operating value.
  Unavailable
  NfvInstGroupStatusRequired
  The Unavailable value.
- operationMode
  NfvInstGroupOperationModeRequired
  See operationMode.
  Normal
  NfvInstGroupOperationModeRequired
  The Normal value.
  Maintenance
  NfvInstGroupOperationModeRequired
  The Maintenance value.
- instances
  ListRequired
  See instances.
  configVersion
  intRequired
  The config version.
  nfvInstGroupUuid
  StringRequired
  The NFV inst group UUID.
  netOsDistro
  StringRequired
  The net OS distro.
  baseOsDistro
  StringRequired
  The base OS distro.
  clusterStatus
  StringRequired
  The cluster status.
  statusDetail
  StringRequired
  The status detail.
  applianceVmType
  StringRequired
  The appliance VM instance type.
  managementNetworkUuid
  StringRequired
  The management network UUID.
  defaultRouteL3NetworkUuid
  StringRequired
  The default route L3 network UUID.
  status
  StringRequired
  The resource status.
  Initializing
  NfvInstGroupStatusRequired
  The Initializing value.
  Healthy
  NfvInstGroupStatusRequired
  The Healthy value.
  Degraded
  NfvInstGroupStatusRequired
  The Degraded value.
  Operating
  NfvInstGroupStatusRequired
  The Operating value.
  Unavailable
  NfvInstGroupStatusRequired
  The Unavailable value.
  agentPort
  IntegerRequired
  The agent port.
  haStatus
  StringRequired
  The HA status.
  uuid
  StringRequired
  The resource UUID.
  name
  StringRequired
  The resource name.
  description
  String
  Optional. The detailed description of the resource.
  zoneUuid
  StringRequired
  The zone UUID.
  clusterUuid
  StringRequired
  The cluster UUID.
  imageUuid
  StringRequired
  The image UUID.
  hostUuid
  StringRequired
  The host UUID.
  lastHostUuid
  StringRequired
  The last host UUID.
  instanceOfferingUuid
  StringRequired
  The instance offering Uuid.
  rootVolumeUuid
  StringRequired
  The root volume UUID.
  platform
  StringRequired
  The platform.
  architecture
  StringRequired
  The architecture.
  defaultL3NetworkUuid
  StringRequired
  The default L3 network UUID.
  type
  StringRequired
  The resource type.
  hypervisorType
  StringRequired
  The hypervisor type.
  memorySize
  LongRequired
  The memory size.
  reservedMemorySize
  LongRequired
  The reserved memory size.
  cpuNum
  IntegerRequired
  The number of CPUs.
  cpuSpeed
  LongRequired
  The CPU speed.
  allocatorStrategy
  StringRequired
  The allocator strategy.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  state
  StringRequired
  The resource state.
  guestOsType
  StringRequired
  The guest OS type.
  vmNics
  ListRequired
  See vmNics.
  uuid
  StringRequired
  The resource Uuid.
  vmInstanceUuid
  StringRequired
  The VM instance Uuid.
  l3NetworkUuid
  StringRequired
  The L3 network Uuid.
  ip
  StringRequired
  The IP address.
  mac
  StringRequired
  The MAC address.
  hypervisorType
  StringRequired
  The hypervisor type.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  metaData
  StringRequired
  The metadata.
  ipVersion
  IntegerRequired
  The IP version.
  driverType
  StringRequired
  The driver type.
  internalName
  StringRequired
  The internal name.
  deviceId
  IntegerRequired
  The device ID.
  type
  StringRequired
  The resource type.
  state
  StringRequired
  The NIC state.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  usedIps
  ListRequired
  See usedIps.
  uuid
  StringRequired
  The resource Uuid.
  ipRangeUuid
  StringRequired
  The IP range Uuid.
  l3NetworkUuid
  StringRequired
  The L3 network Uuid.
  ipVersion
  IntegerRequired
  The IP version.
  ip
  StringRequired
  The IP address.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  usedFor
  StringRequired
  The allocation reason.
  ipInLong
  longRequired
  The IP address represented as a long integer.
  ipInBinary
  byte[]Required
  The IP in binary.
  vmNicUuid
  StringRequired
  The VM NIC Uuid.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  allVolumes
  ListRequired
  See allVolumes.
  uuid
  StringRequired
  The resource Uuid.
  name
  StringRequired
  The resource name.
  description
  String
  Optional. The detailed description of the resource.
  primaryStorageUuid
  StringRequired
  The primary storage Uuid.
  vmInstanceUuid
  StringRequired
  The VM instance Uuid.
  diskOfferingUuid
  StringRequired
  The disk offering Uuid.
  rootImageUuid
  StringRequired
  The root image UUID.
  installPath
  StringRequired
  The installation path.
  type
  StringRequired
  The resource type.
  format
  StringRequired
  The format.
  size
  LongRequired
  The size.
  actualSize
  LongRequired
  The actual size.
  deviceId
  IntegerRequired
  The device ID.
  state
  StringRequired
  The resource state.
  status
  StringRequired
  The resource status.
  Initializing
  NfvInstGroupStatusRequired
  The Initializing value.
  Healthy
  NfvInstGroupStatusRequired
  The Healthy value.
  Degraded
  NfvInstGroupStatusRequired
  The Degraded value.
  Operating
  NfvInstGroupStatusRequired
  The Operating value.
  Unavailable
  NfvInstGroupStatusRequired
  The Unavailable value.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  isShareable
  BooleanRequired
  Whether the resource is shareable.
  volumeQos
  StringRequired
  The volume QoS.
  lastDetachDate
  TimestampRequired
  The last detach date.
  lastVmInstanceUuid
  StringRequired
  The last VM instance UUID.
  vmCdRoms
  ListRequired
  See vmCdRoms.
  uuid
  StringRequired
  The resource Uuid.
  vmInstanceUuid
  StringRequired
  The VM instance Uuid.
  deviceId
  IntegerRequired
  The device ID.
  isoUuid
  StringRequired
  The ISO UUID.
  isoInstallPath
  StringRequired
  The ISO install path.
  name
  StringRequired
  The resource name.
  description
  String
  Optional. The detailed description of the resource.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
- monitors
  ListRequired
  See monitors.
  id
  LongRequired
  The resource ID.
  nfvInstGroupUuid
  StringRequired
  The NFV inst group UUID.
  monitorIp
  StringRequired
  The monitor IP.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
- services
  ListRequired
  See services.
  id
  LongRequired
  The resource ID.
  nfvInstGroupUuid
  StringRequired
  The NFV inst group UUID.
  networkServiceName
  StringRequired
  The network service name.
  networkServiceUuid
  StringRequired
  The network service UUID.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
- configTasks
  ListRequired
  See configTasks.
  id
  longRequired
  The resource ID.
  nfvInstGroupUuid
  StringRequired
  The NFV inst group UUID.
  configVersion
  intRequired
  The config version.
  serviceUuid
  StringRequired
  The service UUID.
  taskName
  StringRequired
  The task name.
  taskData
  StringRequired
  The task data.
  path
  StringRequired
  The path.
  checkStatus
  booleanRequired
  The check status.
- l3Networks
  ListRequired
  See l3Networks.
  nfvInstGroupUuid
  StringRequired
  The NFV inst group UUID.
  networkServiceUuid
  StringRequired
  The network service UUID.
  l3NetworkUuid
  StringRequired
  The L3 network Uuid.
  l3NetworkCategory
  StringRequired
  The L3 network category.
  l3NetworkType
  StringRequired
  The L3 network type.
  type
  StringRequired
  The resource type.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.

Request Example

Conversion Warnings

python: command should begin with "curl" but instead begins with "http://localhost:8080/zstac..." http://localhost:8080/zstack/v1/nfvinstgroup/group ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
javascript: command should begin with "curl" but instead begins with "http://localhost:8080/zstac..." http://localhost:8080/zstack/v1/nfvinstgroup/group ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
java: command should begin with "curl" but instead begins with "http://localhost:8080/zstac..." http://localhost:8080/zstack/v1/nfvinstgroup/group ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
go: command should begin with "curl" but instead begins with "http://localhost:8080/zstac..." http://localhost:8080/zstack/v1/nfvinstgroup/group ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

curl -X POST '{host}/zstack/v1/nfvinstgroup/group' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "paramsstructure": {
    "name": "{name}",
    "description": "{description}",
    "instType": "{instType}",
    "funcType": "{funcType}",
    "monitorIps": [
      "{monitorIps}"
    ],
    "nfvInstOfferingUuid": "{nfvInstOfferingUuid}",
    "frontEndL3NetworkUuid": "{frontEndL3NetworkUuid}",
    "backendL3NetworkUuids": [
      "{backendL3NetworkUuids}"
    ],
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ],
    "netOsDistro": "{netOsDistro}",
    "baseOsDistro": "{baseOsDistro}",
    "vipUuid": "{vipUuid}",
    "ipv6VipUuid": "{ipv6VipUuid}",
    "primaryStorageUuid": "{primaryStorageUuid}",
    "primaryStoragePoolUuid": "{primaryStoragePoolUuid}",
    "clusterUuid": "{clusterUuid}",
    "zoneUuid": "{zoneUuid}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "inventory": {
    "configVersion": 0,
    "l3Networks": []
  }
}

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-09-23
AddedRequest body fields paramsstructure
View API

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations