---
title: "query products"
method: GET
path: "/products/"
tags: ["product"]
---

# query products

`GET /products/`

query products

## Query parameters

- `productIDs` string[]

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `products` StructsProductConfigInfo[]
      - `components` StructsProductComponentPropertyWithZones[]
        - `availableZones` StructsComponentInstanceZoneWithSpecs[] — Information on the specifications of the resources online for the running of product components,organized by different Zone
          - `specs` StructsComponentInstanceResourceSpec[]
            - `cpu` integer
            - `diskType` string — eg: NVMeSSD/SSD/SATA
            - `id` string — ID of the instance resource specification
            - `memory` integer — The amount of memory occupied by the instance, in GiB
            - `name` string — Name of the instance resource specification,eg: TiDB.c1.large
            - `zoneId` string
            - `zoneName` string
          - `zoneId` string
          - `zoneName` string
        - `endPort` integer
        - `id` string — ID of the product component, globally unique
        - `maxInstance` integer — Maximum number of instances when the product component is running, e.g. PD can run up to 7 instances, other components have no upper limit
        - `maxPort` integer
        - `minInstance` integer — Minimum number of instances of product components at runtime, e.g. at least 1 instance of PD, at least 3 instances of TiKV
        - `name` string — Name of the product component, globally unique
        - `purposeType` string — The type of resources required by the product component at runtime, e.g. storage class
        - `startPort` integer
        - `suggestedInstancesCount` integer[]
      - `productId` string
      - `productName` string
      - `versions` StructsSpecificVersionProduct[]
        - `arch` string
        - `productId` string
        - `version` string
  - `message` string

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

## Changes

> 50 revisions in range; 26 could not be searched.

- **2022-03-11** `a1097ecc22a7` — 3 warning, 3 info
  - deleted the `query` request parameter `internalProduct`
  - deleted the `query` request parameter `status`
  - deleted the `query` request parameter `vendorId`
  - api tag `product` added
  - …2 more
- **2022-03-11** `46f6886d4cb2` — 1 warning, 5 info
  - deleted the `query` request parameter `productIDs`
  - api tag `platform` added
  - api tag `product` removed
  - added the new optional `query` request parameter `internalProduct`
  - …2 more
- **2022-03-10** `fb3957694560` — 3 warning, 3 info
  - deleted the `query` request parameter `internalProduct`
  - deleted the `query` request parameter `status`
  - deleted the `query` request parameter `vendorId`
  - api tag `product` added
  - …2 more
- **2022-03-10** `5f9558ed936e` — 1 warning, 5 info
  - deleted the `query` request parameter `productIDs`
  - api tag `platform` added
  - api tag `product` removed
  - added the new optional `query` request parameter `internalProduct`
  - …2 more
- **2022-03-07** `629f291af395` — 3 warning, 3 info
  - deleted the `query` request parameter `internalProduct`
  - deleted the `query` request parameter `status`
  - deleted the `query` request parameter `vendorId`
  - api tag `product` added
  - …2 more

[Full history](https://skmtc.dev/pingcap/apis/em-ui-api/changes/products/get.md)

---

[API](https://skmtc.dev/pingcap/apis/em-ui-api.md) · [All operations](https://skmtc.dev/pingcap/apis/em-ui-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pingcap/em-ui-api/revisions/631e4b26b7e8/schema)