deploy.apps.resources

Show the app as a tree: deployment, load balancer, machines, containers, names and bound data, each with health and sync

GET /deploy/api/apps/{id}/resourcesIAM deploy:DescribeAppRead

Bound databases, caches and brokers appear only for a caller who may describe that service. Health is one of healthy, progressing, degraded, suspended, missing, unknown; sync is in_sync, out_of_sync or unknown.

Request syntax

GET /deploy/api/apps/{id}/resources

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with `data`: `health` of the whole app and `nodes`, a flat list in which each node has a key, its parent key, kind, service, name, detail, href, health, sync (or null), reportedAt, events and logStream.

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

Fields of data

  • healthAlways

    object

    Health of the whole app
  • health.​healthAlways

    one of healthy, progressing, degraded, suspended, missing, unknown

    Health
  • health.​reasonAlways

    string

    Why
  • nodesAlways

    array of object

    Every node, flat; parent links them into a tree
  • nodes[].​keyAlways

    string

    Unique key, e.g. machine:i-abc or container:i-abc:web
  • nodes[].​parentAlways

    string, may be null

    Key of the parent node; null for the root
  • nodes[].​kindAlways

    one of app, deployment, load-balancer, machine, container, domain, database, cache, broker

    What the node is
  • nodes[].​serviceAlways

    string

    Service it belongs to
  • nodes[].​nameAlways

    string

    Name
  • nodes[].​detailAlways

    string, may be null

    One line: image, size, address or engine
  • nodes[].​hrefAlways

    string, may be null

    Console path of its own page; null if none
  • nodes[].​healthAlways

    object

    Health and why
  • nodes[].​health.​healthAlways

    one of healthy, progressing, degraded, suspended, missing, unknown

    Health
  • nodes[].​health.​reasonAlways

    string

    Why
  • nodes[].​syncAlways

    object, may be null

    Sync of a machine or container; null for other nodes
  • nodes[].​sync.​syncAlways

    one of in_sync, out_of_sync, unknown

    Whether it runs what it should
  • nodes[].​sync.​reasonAlways

    string

    Why
  • nodes[].​sync.​rollingOutAlways

    boolean

    Out of sync only because a rollout is in progress
  • nodes[].​reportedAtAlways

    string, may be null

    When it last reported; null if never or not applicable
  • nodes[].​eventsAlways

    array of object

    Where its events are read from (resource-activity reads them)
  • nodes[].​events[].​resourceTypeAlways

    string

    Kind of resource the events are about
  • nodes[].​events[].​resourceIdAlways

    string

    Its id
  • nodes[].​logStreamAlways

    string, may be null

    Log stream prefix of a container; null otherwise

Checked against the handlers: every route test validates their answers against this schema.

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 deploy:DescribeApp 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 deploy apps resources id

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