更新时间:2023-06-26 GMT+08:00
分享

高级设置

功能介绍

修改调优参数的值。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v3/{project_id}/job/{job_id}/tuning-params/modify-params

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

job_id

String

租户在某一Region下的Job ID,如果是主备任务,使用父任务ID。

获取方法请参见获取任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型

缺省值:en-us

枚举值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

full_sync

Map<String,String>

全量参数的参数名及对应的取值。

incre_capture

Map<String,String>

增量抓取参数的参数名及对应的取值。

incre_apply

Map<String,String>

增量回放参数的参数名及对应的取值。

incre_relay

Map<String,String>

增量日志拉取参数的参数名及对应的取值。slotAdvanceInterval: 源库逻辑复制槽推进间隔。

recovery

Boolean

初始化参数,首次调用时需要传true,其他时候不传。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

full_sync

Array of objects

全量调优参数。

详情请参见表5

incre_capture

Array of objects

增量抓取调优参数。

详情请参见表5 TuningParameterfull_sync、incre_capture、incre_apply和incre_relay字段数据结构说明

incre_apply

Array of objects

增量回放调优参数。

详情请参见表5 TuningParameterfull_sync、incre_capture、incre_apply和incre_relay字段数据结构说明

incre_relay

Array of objects

增量日志拉取调优参数。

详情请参见表5 TuningParameterfull_sync、incre_capture、incre_apply和incre_relay字段数据结构说明

modify_result

String

参数修改是否成功。

表5 full_sync、incre_capture、incre_apply和incre_relay字段数据结构说明

参数

参数类型

描述

param_name

String

参数名称

param_value

String

参数取值

availability

String

是否可用

请求示例

  • GaussDB主备版到kafka任务设置指定源库逻辑复制槽推进间隔
    https://{endpoint}/v3/054c06d8aa00d39e2f6cc00176952b8b/job/1e3f710f-4df3-4fc9-8a29-0ec72c5jb2b3/tuning-params/modify-params
    
    {
      "incre_relay" : {
        "slotAdvanceInterval" : "5"
      }
    }
  • 初始化高级参数
    https://{endpoint}/v3/054c06d8aa00d39e2f6cc00176952b8b/job/1e3f710f-4df3-4fc9-8a29-0ec72c5jb2b3/tuning-params/modify-params
    
    {
      "recovery" : true
    }

响应示例

状态码: 200

OK

{
  "full_sync" : [ ],
  "incre_capture" : [ ],
  "incre_apply" : [ ],
  "incre_relay" : [ {
    "param_name" : "slotAdvanceInterval",
    "param_value" : "5"
  } ],
  "modify_result" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品