修改租户参数 | OceanBase 文档中心

修改租户参数

更新时间：2024-10-18 17:00:42

功能说明

该接口用于修改租户的参数。

调用说明

接口约束

调用者需具备目标租户的更新权限。

关于调用者的权限，详情可参见安全概述。
调用者需要通过 OCP 应用服务鉴权。

请求路径

PUT /api/v2/ob/clusters/{id}/tenants/{tenantId}/parameters

path:

参数	类型	必选	示例值	描述
id	Long	是	1	目标租户所属集群的 ID。
tenantId	Long	是	10	目标租户的 ID。

请求参数

参数	类型	必选	示例值	描述
TenantParameterParam	Array	是	NA	TenantParameterParam 列表。

TenantParameterParam 数据结构

参数	类型	必选	示例值	描述
name	String	是	ob_default_replica_num	参数，表示 OB 默认副本数。
value	String	是	2	参数值。
parameterType	String	是	OB_SYSTEM_VARIABLE	参数类型，取值为 OB_SYSTEM_VARIABLE（变量）或 OB_TENANT_PARAMETER（参数）。

返回结果

基础数据结构

参数	类型	说明
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的应用服务的地址。

示例

请求示例

PUT /api/v2/ob/clusters/1/tenants/12/parameters

body:

[
  {
    "name": "ob_default_replica_num",
    "value": 2
  }
]

返回示例

{
  "duration": 3464,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-05T23:38:06.907+08:00",
  "traceId": "9d3721be71e94f25"
}