1. 接口描述
允许已授权的用户通过此接口更新自己的信息
- URL:/v2/webservice/table/table-slave-read-update
- Method:post
- Content-Type: application/json
- 需要登录:是
- 需要鉴权:是
2. 请求参数
| 参数 | 是否必填 | 类型 | 说明 | |
|---|---|---|---|---|
| app_id | Yes | Number | ||
| zone_id | Yes | Number | ||
| table_name | Yes | String | ||
| date | Yes | Number | String | 重复执行频率,0表示不生效,-1表示每天;或者是日期字符串("2023-04-23") |
| hour | Yes | Number | Array | 分流时间段,0表示不生效,-1表示全天,传数组表示生效时间段(例如:[12,18]) |
| level | Yes | Number | 读分流级别,0表示不生效,1表示read batch,2表示read multi,3表示read all | |
| ratio | Yes | Number | 分流比例,0到100之间 | |
| retry | Yes | Number | 异常提醒,1表示推送至Server,0表示不推送至Server | |
| ignore_conflict | No | Number | 是否忽略任务冲突,1表示忽略,0表示不忽略。 |
ignore_conflict参数说明:当提交的参数为开启读分流,ignore_conflict填0表示检查是否存在事务冲突。如果存在冲突任务(存储层自动扩容、存储层手动扩容、存储层缩容、变更磁盘内存比、复制表数据、shard搬迁、设备搬迁),接口会返回报错信息提醒用户冲突的任务ID。如果想继续开启读分流,则将ignore_conflict 参数改为1,可忽略冲突的任务。
3. 返回data参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | String | |
| request_id | String | |
| data | Array | 结果数组 |
3.1. data参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| set_id | Number | 集群ID |
| task_id | Number | 任务ID |
| user | String | 用户名 |
4. 请求示例
示例1:描述示例1
{
"app_id": 2,
"zone_id": 5,
"table_name": "table_generic",
"date": 0,
"hour": [12, 18],
"level": 0,
"ratio": 50,
"retry": 1,
"ignore_conflict": 0
}
5. 成功响应
{
"code": 0,
"request_id": "34a52d01-9b58-478c-a0d7-2bcad9a15a74",
"data": {
"set_id": 1,
"task_id": 384,
"user": "tcaplus"
}
}
6. 错误响应
条件:表不存在
响应示例:
{
"request_id": "14392337-a95b-4884-8d4f-a62980b8c4f6",
"code": 102,
"message": "表不存在",
"debug_message": {
"app_id": 2,
"zone_id": 5,
"table_name": "table_generc",
"date": 0,
"hour": ["12", "18"],
"level": 0,
"ratio": 50,
"retry": 1,
"ignore_conflict": 0
}
}