---
title: "query parameters of a cluster"
method: GET
path: "/clusters/{clusterId}/params"
tags: ["cluster parameters"]
---

# query parameters of a cluster

`GET /clusters/{clusterId}/params`

query parameters of a cluster

## Path parameters

- `clusterId` string, required

## Query parameters

- `instanceType` string
- `page` integer
- `pageSize` integer
- `paramName` string

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `paramGroupId` string
    - `params` StructsClusterParameterInfo[]
      - `category` string
      - `createTime` integer
      - `defaultValue` string
      - `description` string
      - `hasApply` 0 | 1
      - `hasReboot` 0 | 1
      - `instanceType` string
      - `name` string
      - `note` string
      - `paramId` string
      - `range` string[]
      - `rangeType` 0 | 1 | 2
      - `readOnly` 0 | 1
      - `realValue` StructsParameterRealValue
        - `clusterValue` string
        - `instanceValue` StructsClusterInstanceParameterValue[]
          - `instanceId` string
          - `value` string
      - `systemVariable` string
      - `type` 0 | 1 | 2 | 3 | 4
      - `unit` string
      - `unitOptions` string[]
      - `updateSource` 0 | 1 | 2 | 3 | 4
      - `updateTime` integer
  - `message` string
  - `page` ControllerPage
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

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

---

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