---
title: "inspect parameters"
method: POST
path: "/clusters/{clusterId}/params/inspect"
tags: ["cluster parameters"]
---

# inspect parameters

`POST /clusters/{clusterId}/params/inspect`

inspect parameters

## Path parameters

- `clusterId` string, required

## Request body

- ClusterInspectParametersReq
  - `instanceId` string

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `params` ClusterInspectParameters[]
      - `instanceId` string
      - `instanceType` string
      - `parameterInfos` ClusterInspectParameterInfo[]
        - `category` string
        - `description` string
        - `hasReboot` 0 | 1
        - `inspectValue` object
        - `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[]
  - `message` string

## 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)