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

QuerySlbGroup

QuerySlbGroup

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.

  • 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.

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The UUID of the SLB group.

    • nameStringRequired

      The name of the SLB group.

    • backendTypeStringRequired

      后端类型。

    • deployTypeStringRequired

      部署类型。

    • slbOfferingUuidStringRequired

      No description provided.

    • descriptionStringRequired

      The detailed description of the SLB group.

    • createDateTimestampRequired

      The time when the SLB group was created.

    • lastOpDateTimestampRequired

      The time when the SLB group was last modified.

    • slbVmsListRequired

      See slbVms.

      • slbGroupUuidStringRequired

        No description provided.

      • publicNetworkUuidStringRequired

        No description provided.

      • virtualRouterVipsListRequired

        No description provided.

      • applianceVmTypeStringRequired

        设备云主机类型。

      • managementNetworkUuidStringRequired

        No description provided.

      • defaultRouteL3NetworkUuidStringRequired

        No description provided.

      • statusStringRequired

        状态信息。

      • agentPortIntegerRequired

        代理端口。

      • haStatusStringRequired

        HA状态。

      • uuidStringRequired

        The VM UUID.

      • nameStringRequired

        The name of the VM instance.

      • descriptionStringRequired

        The detailed description of the VM instance.

      • 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

        平台。

      • defaultL3NetworkUuidStringRequired

        No description provided.

      • typeStringRequired

        类型。

      • hypervisorTypeStringRequired

        No description provided.

      • memorySizeLongRequired

        内存大小。

      • cpuNumIntegerRequired

        No description provided.

      • cpuSpeedLongRequired

        No description provided.

      • allocatorStrategyStringRequired

        No description provided.

      • createDateTimestampRequired

        The time when the VM instance was created.

      • lastOpDateTimestampRequired

        The time when the VM instance was last modified.

      • stateStringRequired

        当前状态。

      • 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.

        • createDateTimestampRequired

          The time when the NIC was added to the VM instance.

        • 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.

          • 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.

        • 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.

      • 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.

    • lbsListRequired

      See lbs.

      • slbGroupUuidStringRequired

        No description provided.

      • nameStringRequired

        The name of the load balancer.

      • uuidStringRequired

        The UUID of the load balancer.

      • descriptionStringRequired

        The detailed description of the load balancer.

      • stateStringRequired

        当前状态。

      • typeStringRequired

        类型。

      • vipUuidStringRequired

        The virtual IP UUID.

      • createDateTimestampRequired

        The time when the oad balancer was created.

      • lastOpDateTimestampRequired

        The time when the load balancer was last modified.

      • listenersListRequired

        See listeners

        • uuidStringRequired

          The listener UUID.

        • nameStringRequired

          The name of the listener.

        • descriptionStringRequired

          The detailed description of the listener.

        • loadBalancerUuidStringRequired

          The load balancer UUID.

        • instancePortIntegerRequired

          实例端口。

        • loadBalancerPortIntegerRequired

          No description provided.

        • protocolStringRequired

          认证协议。

        • serverGroupUuidStringRequired

          服务器组UUID。

        • createDateTimestampRequired

          The time when the listener was created.

        • lastOpDateTimestampRequired

          The time when the listener was last modified.

        • vmNicRefsListRequired

          See vmNicRefs.

          • idLongRequired

            资源ID。

          • listenerUuidStringRequired

            No description provided.

          • vmNicUuidStringRequired

            The VM NIC UUID.

          • statusStringRequired

            状态信息。

          • createDateTimestampRequired

            The time when the NIC was added to the VM instance.

          • lastOpDateTimestampRequired

            The time when the NIC was last modified.

        • aclRefsListRequired

          See aclRefs.

          • idLongRequired

            The record ID.

          • listenerUuidStringRequired

            The listener UUID.

          • aclUuidStringRequired

            The UUID of the access control list (ACL).

          • typeStringRequired

            The type of the ACL.

          • createDateTimestampRequired

            The time when the ACL was created.

          • lastOpDateTimestampRequired

            The time when the ACL was last modified.

        • certificateRefsListRequired

          See certificateRefs.

          • idLongRequired

            资源ID。

          • listenerUuidStringRequired

            No description provided.

          • certificateUuidStringRequired

            No description provided.

          • createDateTimestampRequired

            The time when the certificate was created.

          • lastOpDateTimestampRequired

            The time when the certificate was last modified.

        • serverGroupRefsListRequired

          See serverGroupRefs.

          • idlongRequired

            资源ID。

          • listenerUuidStringRequired

            No description provided.

          • serverGroupUuidStringRequired

            服务器组UUID。

          • createDateTimestampRequired

            The time when the server group was created.

          • lastOpDateTimestampRequired

            The time when the server group was last modified.

    • networksListRequired

      See networks.

      • slbGroupUuidStringRequired

        No description provided.

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • l3NetworkCategoryStringRequired

        No description provided.

      • l3NetworkTypeStringRequired

        No description provided.

      • typeStringRequired

        类型。

      • createDateTimestampRequired

        The time when the network was created.

      • lastOpDateTimestampRequired

        The time when the network was last modified.

Endpoint

GET/zstack/v1/load-balancers/slb/groups

/zstack/v1/load-balancers/slb/groups

Operation ID

QuerySlbGroup

Permalink

Request Example

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

Response Example

200
{ "inventories": [ { "name": "slb", "backendType": "vyos", "deployType": "direct", "description": "slb test" } ] }

Change History

This API has no change history records yet.

View all change history