lb.load-balancers.get

One load balancer with its services and targets

GET /lb/api/load-balancers/{id}IAM lb:DescribeLoadBalancersRead

Request syntax

GET /lb/api/load-balancers/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with { lb, services, targets, rules, application, dedicated }: `lb` as `list` shows it; `services` by port (protocol, sourcePort, destinationPort, health-check and sticky settings, domains, certificateSource, certificateStatus, certificateNotAfter, certificateError, …); `targets` (type, instanceId, ip, usePrivateIp, targetGroup, status healthy/unhealthy/unknown); `rules` by priority; `application` (application type, else null: hostnames, limits, price, warnings such as a rule whose group has no target) and `dedicated` (dedicated type, else null: scheme, addresses, limits, price). 404 when it is not in your organization.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow lb:DescribeLoadBalancers on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud lb load-balancers get id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_lb_load-balancers_get.