Skip to main content
API Explorer|API Explorer
Resource Center/Network Service/Network Service Operations/Load Balancing Operations
POSTLoad Balancing OperationsSince 0.6SynchronousAuth Required

CreateSlbInstance

CreateSlbInstance

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, 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.

  • inventorySlbVmInstanceInventoryRequired

    See inventory.

    • slbGroupUuidStringRequired

      No description provided.

    • configVersionlongRequired

      配置版本。

    • publicNetworkUuidStringRequired

      No description provided.

    • virtualRouterVipsListRequired

      No description provided.

    • applianceVmTypeStringRequired

      设备云主机类型。

    • managementNetworkUuidStringRequired

      No description provided.

    • defaultRouteL3NetworkUuidStringRequired

      No description provided.

    • statusStringRequired

      状态信息。

      • PendingSlbVmInstanceConfigTaskStatusRequired

        待处理。

      • StartingSlbVmInstanceConfigTaskStatusRequired

        启动中。

      • SuccessSlbVmInstanceConfigTaskStatusRequired

        成功。

      • FailedSlbVmInstanceConfigTaskStatusRequired

        失败。

    • agentPortIntegerRequired

      代理端口。

    • haStatusStringRequired

      HA状态。

    • uuidStringRequired

      The Uuid.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      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.

    • configTasksListRequired

      See configTasks.

      • vmInstanceUuidStringRequired

        The VM instance Uuid.

      • configVersionlongRequired

        配置版本。

      • taskNameStringRequired

        任务名称。

      • taskDataStringRequired

        任务数据。

      • retryNumberlongRequired

        重试数量。

      • lastFailedReasonStringRequired

        最近一次失败原因。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last creation date.

      • statusSlbVmInstanceConfigTaskStatusRequired

        See status.

        • PendingSlbVmInstanceConfigTaskStatusRequired

          待处理。

        • StartingSlbVmInstanceConfigTaskStatusRequired

          启动中。

        • SuccessSlbVmInstanceConfigTaskStatusRequired

          成功。

        • FailedSlbVmInstanceConfigTaskStatusRequired

          失败。

    • vmNicsListRequired

      See vmNics.

      • uuidStringRequired

        The NIC UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • ipStringRequired

        The IP address of the NIC.

      • macStringRequired

        The MAC address of the NIC.

      • hypervisorTypeStringRequired

        The virtualization type.

      • netmaskStringRequired

        The netmask.

      • gatewayStringRequired

        The gateway IP address.

      • metaDataStringRequired

        元数据。

      • ipVersionIntegerRequired

        The IP version.

      • deviceIdIntegerRequired

        The device ID.

      • typeStringRequired

        The NIC type.

      • stateStringRequired

        The NIC state.

      • createDateTimestampRequired

        The time when the NIC was created.

      • lastOpDateTimestampRequired

        The time when the NIC was last modified.

      • usedIpsListRequired

        See usedIps.

        • uuidStringRequired

          The IP address UUID.

        • ipRangeUuidStringRequired

          The IP range UUID.

        • l3NetworkUuidStringRequired

          The L3 network UUID.

        • ipVersionIntegerRequired

          The IP version.

        • ipStringRequired

          The IP address.

        • netmaskStringRequired

          The netmask.

        • gatewayStringRequired

          The gateway IP address.

        • usedForStringRequired

          分配原因

        • ipInLonglongRequired

          No description provided.

        • ipInBinarybyte[]Required

          No description provided.

        • vmNicUuidStringRequired

          The VM Nic Uuid.

        • createDateTimestampRequired

          The time when the IP address was used.

        • lastOpDateTimestampRequired

          The time when the was last modified.

    • allVolumesListRequired

      See allVolumes.

      • uuidStringRequired

        The volume UUID.

      • nameStringRequired

        The volume name.

      • descriptionStringRequired

        The detailed description of the volume.

      • primaryStorageUuidStringRequired

        The primary storage UUID.

      • vmInstanceUuidStringRequired

        The bare metal instance UUID.

      • diskOfferingUuidStringRequired

        The volume offering UUID.

      • rootImageUuidStringRequired

        The root image UUID.

      • installPathStringRequired

        The installation path of the volume in the primary storage.

      • typeStringRequired

        The type of the volume.

      • formatStringRequired

        The format of the volume.

      • sizeLongRequired

        The size of the volume.

      • actualSizeLongRequired

        The actual storage space that the volume takes up.

      • deviceIdIntegerRequired

        设备ID。

      • stateStringRequired

        The state of the volume.

      • statusStringRequired

        The status of the volume.

        • PendingSlbVmInstanceConfigTaskStatusRequired

          待处理。

        • StartingSlbVmInstanceConfigTaskStatusRequired

          启动中。

        • SuccessSlbVmInstanceConfigTaskStatusRequired

          成功。

        • FailedSlbVmInstanceConfigTaskStatusRequired

          失败。

      • createDateTimestampRequired

        The time when the volume was created.

      • lastOpDateTimestampRequired

        The time when the volume was last modified.

      • isShareableBooleanRequired

        Indicates whether the volume is shareable.

      • volumeQosStringRequired

        The QoS of the volume, for example, 1048576.

      • lastDetachDateTimestampRequired

        最近一次detach时间。

      • lastVmInstanceUuidStringRequired

        最近一次云主机实例UUID。

    • vmCdRomsListRequired

      See vmCdRoms.

      • uuidStringRequired

        The CD-ROM UUID.

      • vmInstanceUuidStringRequired

        The VM instance UUID.

      • deviceIdIntegerRequired

        The device ID.

      • isoUuidStringRequired

        The ISO image UUID.

      • isoInstallPathStringRequired

        The installation path of the ISO image.

      • nameStringRequired

        The CD-ROM name.

      • descriptionStringRequired

        The detailed description of the CD-ROM.

      • createDateTimestampRequired

        The time when the CD-ROM was created.

      • lastOpDateTimestampRequired

        The time when the CD-ROM was last modified.

Endpoint

POST/zstack/v1/load-balancers/slb/instances

/zstack/v1/load-balancers/slb/instances

Operation ID

CreateSlbInstance

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/load-balancers/slb/instances' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventory": { "configVersion": 0 } }

Change History

This API has no change history records yet.

View all change history