---
title: "Get a summary info about an instance"
method: GET
path: "/resources/{instance}/info"
tags: ["rpaas"]
---

# Get a summary info about an instance

`GET /resources/{instance}/info`

## Path parameters

- `instance` string, required

## Response `200`

OK

- InstanceInfo
  - `name` string
  - `description` string
  - `team` string
  - `tags` string[]
  - `plan` string
  - `flavors` string[]
  - `replicas` number
  - `autoscale` Autoscale
    - `minReplicas` integer, required — The lower limit for the number of replicas to which the autoscaler can scale down. It cannot be greater than `maxReplicas`. It can be zero when set along with `rps` and/or `schedules` targets.
    - `maxReplicas` integer, required — The upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that `minReplicas`.
    - `cpu` integer — Target average of CPU utilization over running replicas (e.g. 95 means 95%)
    - `memory` integer — Target average of memory utilization over running replicas (e.g. 80 means 80%)
    - `rps` integer — Target average of HTTP requests per seconds over running replicas (e.g. 100 means 100 req/s)
    - `schedules` ScheduledWindow[] — Schedules are recurring or not time-windows where the instance can scale in/out regardless of traffic or resource utilization.
      - `minReplicas` integer, required — Min number of running pods while this window is active.
      - `start` string, required — An Cron expression defining the start of the scheduled window.
      - `end` string, required — An Cron expression defining the end of the scheduled window.
      - `timezone` string — Timezone is a zone name registered on IANA time zone database, default is UTC.
    - `behavior` Behavior
      - `scaleDown` ScaleDown
        - `stabilizationWindowSeconds` integer — is the number of seconds for which past recommendations should be considered while scaling up or scaling down.
        - `unitsPolicyValue` integer — set a policy with (value: unitsPolicyValue, type: Pods, periodSeconds: 60s)
        - `percentPolicyValue` integer — set a policy with (value: percentPolicyValue, type: Percent, periodSeconds: 60s)
  - `pods` PodInfo[]
    - `name` string
    - `ip` string
    - `host` string
    - `ports` PodPortInfo[]
      - `name` string
      - `hostPort` number
      - `containerPort` number
      - `protocol` string
      - `hostIP` string
    - `createdAt` string, date-time
  - `certificates` CertificateInfo[]
    - `name` string
    - `dnsNames` string[]
    - `publicKeyAlgorithm` 'ECDSA' | 'RSA'
    - `publicKeyBitSize` number
    - `validFrom` string, date-time
    - `validUntil` string, date-time
  - `blocks` Block[]
    - `block_name` 'root' | 'http' | 'server' | 'lua-server' | 'lua-worker'
    - `content` string
  - `routes` Route[]
    - `path` string
    - `destination` string
    - `https_only` boolean
    - `content` string

## Other responses

- `404` — Instance not found
- `default` — Unknonw error

## Changes

> 17 revisions in range; 2 not diffed, 1 could not be searched.

- **2024-01-30** `e7e4a11d7199` — 1 info
  - added the optional property `autoscale/schedules/items/timezone` to the response with the `200` status
- **2023-08-01** `702550ccd283` — 1 info
  - added the optional property `autoscale/schedules` to the response with the `200` status
- **2023-07-21** `1c0398a775bb` — 4 info
  - added the optional property `autoscale/rps` to the response with the `200` status
  - the response property `Msg` became required for the status `404`
  - the response property `autoscale/maxReplicas` became required for the status `200`
  - the response property `autoscale/minReplicas` became required for the status `200`
- **2020-08-17** `f427a0b3759f` — 7 breaking, 3 warning
  - the response property `Msg` became optional for the status `404`
  - the response property `autoscale/maxReplicas` became optional for the status `200`
  - the response property `autoscale/minReplicas` became optional for the status `200`
  - the `autoscale/cpu` response's property type/format changed from `integer`/`` to `number`/`` for status `200`
  - …6 more

[Change history](https://skmtc.dev/tsuru/apis/reverse-proxy-as-a-service/changes/resources/:instance/info/get.md)

---

[API](https://skmtc.dev/tsuru/apis/reverse-proxy-as-a-service.md) · [All operations](https://skmtc.dev/tsuru/apis/reverse-proxy-as-a-service/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tsuru/reverse-proxy-as-a-service/revisions/611d7951dc76/schema)