# modify tidb cluster tiflash status - ModifyTiDBClusterTiFlash

## Overview

modify tidb cluster tiflash status






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ModifyTiDBClusterTiFlash`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [Region and Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **Id** | string | TIDB service id |**Yes**|
| **Enable** | string | tiflash state |**Yes**|
| **NodeConfig.ServerType** | string | node server type |**Yes**|
| **NodeConfig.NodeCount** | int | node count |**Yes**|
| **NodeConfig.ConfigId** | string | node config id |**Yes**|
| **NodeConfig.DiskSize** | int | node disk size |**Yes**|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **ServiceId** | string | TiDB service id |No|




## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=ModifyTiDBClusterTiFlash
&Region=cn-zj
&Id=sHCmfZYH
&Enable=XTDagPZt
&BinlogGc=qFDtitjv
&CouponId=ysZfithV
&NodeConfig.ServerType=ouKhaWeR
&NodeConfig.NodeCount=2
&NodeConfig.ConfigId=HbOtdMdd
&NodeConfig.DiskSize=4
&OrderDetail.N.ProductName=FMbtEYsu
&OrderDetail.N.Multiple=3
```

### Response Example
    
```json
{
  "Action": "ModifyTiDBClusterTiFlashResponse",
  "RetCode": 0,
  "ServiceId": "BwnRRYgE"
}
```