跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/SDN设备相关接口
POSTHardware SDN Controller Operations起始版本 0.6同步需要认证

创建NFV高可用组

创建NFV高可用组

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • nameString必填

    资源名称。

  • descriptionString

    资源的详细描述。

  • instTypeString必填

    暂无描述。

  • funcTypeString必填

    函数类型。

  • monitorIpsList

    可选。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryNfvInstGroupInventory必填

    详情参考inventory

    • nameString必填

      资源名称

    • uuidString必填

      资源的UUID，唯一标示该资源

    • descriptionString

      资源的详细描述

    • nfvInstOfferingUuidString必填

      暂无描述。

    • configVersionint必填

      配置版本。

    • netOsDistroString必填

      暂无描述。

    • baseOsDistroString必填

      暂无描述。

    • statusDetailString必填

      状态详情。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • vipUuidString必填

      暂无描述。

    • ipv6VipUuidString必填

      暂无描述。

    • primaryStorageUuidString必填

      主存储UUID

    • primaryStoragePoolUuidString必填

      主存储池UUID。

    • clusterUuidString必填

      集群UUID

    • zoneUuidString必填

      区域UUID

    • instTypeInstType必填

      详情参考instType

      • KVMInstType必填

        暂无描述。

      • CONTAINERInstType必填

        容器。

      • HOSTInstType必填

        主机。

    • funcTypeFuncType必填

      详情参考functype

      • OVN_SDN_CONTROLLERFuncType必填

        暂无描述。

    • statusNfvInstGroupStatus必填

      详情参考status

      • InitializingNfvInstGroupStatus必填

        暂无描述。

      • HealthyNfvInstGroupStatus必填

        健康。

      • DegradedNfvInstGroupStatus必填

        降级。

      • OperatingNfvInstGroupStatus必填

        操作。

      • UnavailableNfvInstGroupStatus必填

        不可用。

    • operationModeNfvInstGroupOperationMode必填

      详情参考OperationMode

      • NormalNfvInstGroupOperationMode必填

        正常。

      • MaintenanceNfvInstGroupOperationMode必填

        维护。

    • instancesList必填

      详情参考instances

      • configVersionint必填

        配置版本。

      • nfvInstGroupUuidString必填

        暂无描述。

      • netOsDistroString必填

        暂无描述。

      • baseOsDistroString必填

        暂无描述。

      • clusterStatusString必填

        集群状态。

      • statusDetailString必填

        状态详情。

      • applianceVmTypeString必填

        设备云主机类型。

      • managementNetworkUuidString必填

        暂无描述。

      • defaultRouteL3NetworkUuidString必填

        暂无描述。

      • statusString必填

        状态信息。

        • InitializingNfvInstGroupStatus必填

          暂无描述。

        • HealthyNfvInstGroupStatus必填

          健康。

        • DegradedNfvInstGroupStatus必填

          降级。

        • OperatingNfvInstGroupStatus必填

          操作。

        • UnavailableNfvInstGroupStatus必填

          不可用。

      • agentPortInteger必填

        代理端口。

      • haStatusString必填

        HA状态。

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • descriptionString

        资源的详细描述

      • zoneUuidString必填

        区域UUID

      • clusterUuidString必填

        集群UUID

      • imageUuidString必填

        镜像UUID

      • hostUuidString必填

        物理机UUID

      • lastHostUuidString必填

        最近一次主机UUID。

      • instanceOfferingUuidString必填

        计算规格UUID

      • rootVolumeUuidString必填

        根云盘UUID

      • platformString必填

        平台。

      • architectureString必填

        暂无描述。

      • defaultL3NetworkUuidString必填

        暂无描述。

      • typeString必填

        类型。

      • hypervisorTypeString必填

        暂无描述。

      • memorySizeLong必填

        内存大小。

      • reservedMemorySizeLong必填

        已预留内存大小。

      • cpuNumInteger必填

        暂无描述。

      • cpuSpeedLong必填

        暂无描述。

      • allocatorStrategyString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • stateString必填

        当前状态。

      • guestOsTypeString必填

        暂无描述。

      • vmNicsList必填

        详情参考vmNics

        • uuidString必填

          资源的UUID，唯一标示该资源

        • vmInstanceUuidString必填

          云主机UUID

        • l3NetworkUuidString必填

          三层网络UUID

        • ipString必填

          来源IP地址。

        • macString必填

          暂无描述。

        • hypervisorTypeString必填

          暂无描述。

        • netmaskString必填

          暂无描述。

        • gatewayString必填

          暂无描述。

        • metaDataString必填

          元数据。

        • ipVersionInteger必填

          IP版本。

        • driverTypeString必填

          暂无描述。

        • internalNameString必填

          内部名称。

        • deviceIdInteger必填

          设备ID。

        • typeString必填

          类型。

        • stateString必填

          网卡状态

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

        • usedIpsList必填

          详情参考usedIps

          • uuidString必填

            资源的UUID，唯一标示该资源

          • ipRangeUuidString必填

            IP段UUID

          • l3NetworkUuidString必填

            三层网络UUID

          • ipVersionInteger必填

            IP版本。

          • ipString必填

            来源IP地址。

          • netmaskString必填

            暂无描述。

          • gatewayString必填

            暂无描述。

          • usedForString必填

            分配原因

          • ipInLonglong必填

            暂无描述。

          • ipInBinarybyte[]必填

            暂无描述。

          • vmNicUuidString必填

            云主机网卡UUID

          • createDateTimestamp必填

            创建时间

          • lastOpDateTimestamp必填

            最后一次修改时间

      • allVolumesList必填

        详情参考allVolumes

        • uuidString必填

          资源的UUID，唯一标示该资源

        • nameString必填

          资源名称

        • descriptionString

          资源的详细描述

        • primaryStorageUuidString必填

          主存储UUID

        • vmInstanceUuidString必填

          云主机UUID

        • diskOfferingUuidString必填

          云盘规格UUID

        • rootImageUuidString必填

          根镜像UUID。

        • installPathString必填

          安装路径。

        • typeString必填

          类型。

        • formatString必填

          数据格式或导出格式。

        • sizeLong必填

          返回记录数。

        • actualSizeLong必填

          实际大小。

        • deviceIdInteger必填

          设备ID。

        • stateString必填

          当前状态。

        • statusString必填

          状态信息。

          • InitializingNfvInstGroupStatus必填

            暂无描述。

          • HealthyNfvInstGroupStatus必填

            健康。

          • DegradedNfvInstGroupStatus必填

            降级。

          • OperatingNfvInstGroupStatus必填

            操作。

          • UnavailableNfvInstGroupStatus必填

            不可用。

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

        • isShareableBoolean必填

          是否可分享。

        • volumeQosString必填

          暂无描述。

        • lastDetachDateTimestamp必填

          最近一次detach时间。

        • lastVmInstanceUuidString必填

          最近一次云主机实例UUID。

      • vmCdRomsList必填

        详情参考vmCdRoms

        • uuidString必填

          资源的UUID，唯一标示该资源

        • vmInstanceUuidString必填

          云主机UUID

        • deviceIdInteger必填

          设备ID。

        • isoUuidString必填

          暂无描述。

        • isoInstallPathString必填

          iso安装路径。

        • nameString必填

          资源名称

        • descriptionString

          资源的详细描述

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

    • monitorsList必填

      详情参考monitors

      • idLong必填

        资源ID。

      • nfvInstGroupUuidString必填

        暂无描述。

      • monitorIpString必填

        监控IP。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • servicesList必填

      详情参考services

      • idLong必填

        资源ID。

      • nfvInstGroupUuidString必填

        暂无描述。

      • networkServiceNameString必填

        暂无描述。

      • networkServiceUuidString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • configTasksList必填

      详情参考configTasks

      • idlong必填

        资源ID。

      • nfvInstGroupUuidString必填

        暂无描述。

      • configVersionint必填

        配置版本。

      • serviceUuidString必填

        服务UUID。

      • taskNameString必填

        任务名称。

      • taskDataString必填

        任务数据。

      • pathString必填

        路径。

      • checkStatusboolean必填

        检查状态。

    • l3NetworksList必填

      详情参考l3Networks

      • nfvInstGroupUuidString必填

        暂无描述。

      • networkServiceUuidString必填

        暂无描述。

      • l3NetworkUuidString必填

        三层网络UUID

      • l3NetworkCategoryString必填

        暂无描述。

      • l3NetworkTypeString必填

        暂无描述。

      • typeString必填

        类型。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/nfvinstgroup/group

/zstack/v1/nfvinstgroup/group

操作 ID

CreateNfvInstGroup

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/nfvinstgroup/group' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"name":"<name>","description":"<description>","instType":"<instType>","funcType":"<funcType>","monitorIps":["<monitorIps>"],"nfvInstOfferingUuid":"<nfvInstOfferingUuid>","frontEndL3NetworkUuid":"<frontEndL3NetworkUuid>","backendL3NetworkUuids":["<backendL3NetworkUuids>"],"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"systemTags":["<systemTags>"],"userTags":["<userTags>"],"netOsDistro":"<netOsDistro>","baseOsDistro":"<baseOsDistro>","vipUuid":"<vipUuid>","ipv6VipUuid":"<ipv6VipUuid>","primaryStorageUuid":"<primaryStorageUuid>","primaryStoragePoolUuid":"<primaryStoragePoolUuid>","clusterUuid":"<clusterUuid>","zoneUuid":"<zoneUuid>"}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史