Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/Hardware SDN Controller Operations
PUTHardware SDN Controller OperationsSince 5.4.2SynchronousAuth Required

AttachNfvInstToGroup

AttachNfvInstToGroup

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • groupUuidStringRequired

    组UUID。

  • nfvInstUuidStringRequired

    No description provided.

Body Fields

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code, null if operation succeeds, non-null if operation fails, see error..

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryNfvInstGroupInventoryRequired

    See inventory..

    • nameStringRequired

      The resource name.

    • uuidStringRequired

      The resource UUID.

    • descriptionStringRequired

      The detailed description of the resource.

    • nfvInstOfferingUuidStringRequired

      No description provided.

    • configVersionintRequired

      配置版本。

    • netOsDistroStringRequired

      No description provided.

    • baseOsDistroStringRequired

      No description provided.

    • statusDetailStringRequired

      状态详情。

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • vipUuidStringRequired

      The VIP UUID.

    • ipv6VipUuidStringRequired

      No description provided.

    • primaryStorageUuidStringRequired

      The primary storage UUID.

    • primaryStoragePoolUuidStringRequired

      主存储池UUID。

    • clusterUuidStringRequired

      The cluster UUID.

    • zoneUuidStringRequired

      The zone UUID.

    • instTypeInstTypeRequired

      See instType.

      • KVMInstTypeRequired

        No description provided.

      • CONTAINERInstTypeRequired

        容器。

      • HOSTInstTypeRequired

        主机。

    • funcTypeFuncTypeRequired

      See funcType.

      • OVN_SDN_CONTROLLERFuncTypeRequired

        No description provided.

    • statusNfvInstGroupStatusRequired

      See status.

      • InitializingNfvInstGroupStatusRequired

        No description provided.

      • HealthyNfvInstGroupStatusRequired

        健康。

      • DegradedNfvInstGroupStatusRequired

        降级。

      • OperatingNfvInstGroupStatusRequired

        操作。

      • UnavailableNfvInstGroupStatusRequired

        不可用。

    • operationModeNfvInstGroupOperationModeRequired

      See operationMode.

      • NormalNfvInstGroupOperationModeRequired

        正常。

      • MaintenanceNfvInstGroupOperationModeRequired

        维护。

    • instancesListRequired

      See instances.

      • configVersionintRequired

        配置版本。

      • nfvInstGroupUuidStringRequired

        No description provided.

      • netOsDistroStringRequired

        No description provided.

      • baseOsDistroStringRequired

        No description provided.

      • clusterStatusStringRequired

        集群状态。

      • statusDetailStringRequired

        状态详情。

      • applianceVmTypeStringRequired

        设备云主机类型。

      • managementNetworkUuidStringRequired

        No description provided.

      • defaultRouteL3NetworkUuidStringRequired

        No description provided.

      • statusStringRequired

        状态信息。

        • InitializingNfvInstGroupStatusRequired

          No description provided.

        • HealthyNfvInstGroupStatusRequired

          健康。

        • DegradedNfvInstGroupStatusRequired

          降级。

        • OperatingNfvInstGroupStatusRequired

          操作。

        • UnavailableNfvInstGroupStatusRequired

          不可用。

      • agentPortIntegerRequired

        代理端口。

      • haStatusStringRequired

        HA状态。

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • descriptionString

        Optional. The detailed description of the resource.

      • zoneUuidStringRequired

        The zone UUID.

      • clusterUuidStringRequired

        The cluster UUID.

      • imageUuidStringRequired

        The image UUID.

      • hostUuidStringRequired

        The host UUID.

      • lastHostUuidStringRequired

        最近一次主机UUID。

      • instanceOfferingUuidStringRequired

        The instance offering UUID.

      • rootVolumeUuidStringRequired

        The root volume UUID.

      • platformStringRequired

        平台。

      • architectureStringRequired

        No description provided.

      • defaultL3NetworkUuidStringRequired

        No description provided.

      • typeStringRequired

        类型。

      • hypervisorTypeStringRequired

        No description provided.

      • memorySizeLongRequired

        内存大小。

      • reservedMemorySizeLongRequired

        已预留内存大小。

      • cpuNumIntegerRequired

        No description provided.

      • cpuSpeedLongRequired

        No description provided.

      • allocatorStrategyStringRequired

        No description provided.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • stateStringRequired

        当前状态。

      • guestOsTypeStringRequired

        No description provided.

      • vmNicsListRequired

        See vmNics.

        • uuidStringRequired

          The resource UUID.

        • vmInstanceUuidStringRequired

          The VM instance Uuid.

        • l3NetworkUuidStringRequired

          The L3 network UUID.

        • ipStringRequired

          来源IP地址。

        • macStringRequired

          No description provided.

        • hypervisorTypeStringRequired

          No description provided.

        • netmaskStringRequired

          No description provided.

        • gatewayStringRequired

          No description provided.

        • metaDataStringRequired

          元数据。

        • ipVersionIntegerRequired

          IP版本。

        • driverTypeStringRequired

          No description provided.

        • internalNameStringRequired

          内部名称。

        • deviceIdIntegerRequired

          设备ID。

        • typeStringRequired

          类型。

        • stateStringRequired

          The NIC state.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

        • usedIpsListRequired

          See usedIps.

          • uuidStringRequired

            The resource Uuid.

          • ipRangeUuidStringRequired

            The IP range Uuid.

          • l3NetworkUuidStringRequired

            The L3 network Uuid.

          • ipVersionIntegerRequired

            IP版本。

          • ipStringRequired

            来源IP地址。

          • netmaskStringRequired

            No description provided.

          • gatewayStringRequired

            No description provided.

          • usedForStringRequired

            The allocation reason.

          • ipInLonglongRequired

            No description provided.

          • ipInBinarybyte[]Required

            No description provided.

          • vmNicUuidStringRequired

            The VM NIC Uuid.

          • createDateTimestampRequired

            The creation date.

          • lastOpDateTimestampRequired

            The last operation date.

      • allVolumesListRequired

        See allVolumes.

        • uuidStringRequired

          The resource Uuid.

        • nameStringRequired

          The resource name.

        • descriptionString

          Optional. The detailed description of the resource.

        • primaryStorageUuidStringRequired

          The primary storage Uuid.

        • vmInstanceUuidStringRequired

          The VM instance Uuid.

        • diskOfferingUuidStringRequired

          The disk offering Uuid.

        • rootImageUuidStringRequired

          根镜像UUID。

        • installPathStringRequired

          安装路径。

        • typeStringRequired

          类型。

        • formatStringRequired

          数据格式或导出格式。

        • sizeLongRequired

          返回记录数。

        • actualSizeLongRequired

          实际大小。

        • deviceIdIntegerRequired

          设备ID。

        • stateStringRequired

          当前状态。

        • statusStringRequired

          状态信息。

          • InitializingNfvInstGroupStatusRequired

            No description provided.

          • HealthyNfvInstGroupStatusRequired

            健康。

          • DegradedNfvInstGroupStatusRequired

            降级。

          • OperatingNfvInstGroupStatusRequired

            操作。

          • UnavailableNfvInstGroupStatusRequired

            不可用。

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

        • isShareableBooleanRequired

          是否可分享。

        • volumeQosStringRequired

          No description provided.

        • lastDetachDateTimestampRequired

          最近一次detach时间。

        • lastVmInstanceUuidStringRequired

          最近一次云主机实例UUID。

      • vmCdRomsListRequired

        See vmCdRoms.

        • uuidStringRequired

          The resource Uuid.

        • vmInstanceUuidStringRequired

          The VM instance Uuid.

        • deviceIdIntegerRequired

          设备ID。

        • isoUuidStringRequired

          No description provided.

        • isoInstallPathStringRequired

          iso安装路径。

        • nameStringRequired

          The resource name.

        • descriptionString

          Optional. The detailed description of the resource.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

    • monitorsListRequired

      See monitors.

      • idLongRequired

        资源ID。

      • nfvInstGroupUuidStringRequired

        No description provided.

      • monitorIpStringRequired

        监控IP。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • servicesListRequired

      See services.

      • idLongRequired

        资源ID。

      • nfvInstGroupUuidStringRequired

        No description provided.

      • networkServiceNameStringRequired

        No description provided.

      • networkServiceUuidStringRequired

        No description provided.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • configTasksListRequired

      See configTasks.

      • idlongRequired

        资源ID。

      • nfvInstGroupUuidStringRequired

        No description provided.

      • configVersionintRequired

        配置版本。

      • serviceUuidStringRequired

        服务UUID。

      • taskNameStringRequired

        任务名称。

      • taskDataStringRequired

        任务数据。

      • pathStringRequired

        路径。

      • checkStatusbooleanRequired

        检查状态。

    • l3NetworksListRequired

      See l3Networks.

      • nfvInstGroupUuidStringRequired

        No description provided.

      • networkServiceUuidStringRequired

        No description provided.

      • l3NetworkUuidStringRequired

        The L3 network Uuid.

      • l3NetworkCategoryStringRequired

        No description provided.

      • l3NetworkTypeStringRequired

        No description provided.

      • typeStringRequired

        类型。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

PUT/zstack/v1/nfvinstgroup/group/{groupUuid}/instances/{nfvInstUuid}/actions

/zstack/v1/nfvinstgroup/group/{groupUuid}/instances/{nfvInstUuid}/actions

Operation ID

AttachNfvInstToGroup

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/nfvinstgroup/group/{groupUuid}/instances/{nfvInstUuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "name": "ovn-controller-group", "uuid": "7f45e412407e3d66b967c74b10380d04", "description": "OVN SDN Controller HA Group", "configVersion": 0, "l3Networks": [] } }

Change History

This API has no change history records yet.

View all change history