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

QueryLoadBalancer

QueryLoadBalancer

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

    • nameStringRequired

      The resource name.

    • uuidStringRequired

      The resource UUID.

    • descriptionStringRequired

      The detailed description of the resource.

    • stateStringRequired

      当前状态。

    • vipUuidStringRequired

      The VIP UUID.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • listenersListRequired

      See listeners.

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • descriptionStringRequired

        The detailed description of the resource.

      • loadBalancerUuidStringRequired

        The load balancer UUID.

      • instancePortIntegerRequired

        实例端口。

      • loadBalancerPortIntegerRequired

        No description provided.

      • protocolStringRequired

        认证协议。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • vmNicRefsListRequired

        See vmNicRefs.

        • idLongRequired

          资源ID。

        • listenerUuidStringRequired

          No description provided.

        • vmNicUuidStringRequired

          The VM NIC UUID.

        • statusStringRequired

          状态信息。

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

      • certificateRefsListRequired

        See certificateRefs.

        • idLongRequired

          资源ID。

        • listenerUuidStringRequired

          No description provided.

        • certificateUuidStringRequired

          No description provided.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

Endpoint

GET/zstack/v1/load-balancers

/zstack/v1/load-balancers

Operation ID

QueryLoadBalancer

Permalink

Request Example

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

Response Example

200
{ "inventories": [ { "name": "Test-Lb", "uuid": "36c2ba1d4a86409693a2de40fa0473ca", "vipUuid": "8807c418b3b74ee5991006bcc4c670e4" } ] }

Change History

This API has no change history records yet.

View all change history