特别说明：如果区所在集群开启了【自动审核】则单据自动审核，并生成任务。否则申请单是待审核状态，且不会生成任务
请求地址
/v2/webservice/apply/apply-add-table
请求参数
| 参数 | 类型 | 是否必填 | 说明 | 版本要求 |
|---|---|---|---|---|
| app_id | number | 是 | number | |
| attach_id | number[] | 是 | 加表文件ID | |
| tables | array | 是 | 区ID和表名 | |
| auto_check | boolean | 否 | 默认跟随集群，可以设置为false, 会生成待审核的单据 | |
| alloc_resourc_mode | enum0: 系统默认分配2: 手动指定shard分配个数 | 否 | 默认系统自动分配资源，仅在支持自动审核的时候支持 | 当alloc_resourc_mode参数设置为2时，需确保控制台版本不低于1.16.0 |
tables数组元素说明
| 参数名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| zone_id | number | 是 | |
| table_name | string | 是 | |
| auto_execute_task | boolean | 否 | 当集群配置为自动审核时，自动执行时，单据会自动审核，此参数才生效true表示生成任务后自动执行false表示生成任务后，不立即执行任务 |
| shard_num | number | 否 | alloc_resourc_mode=2时生效，为空或 0 则系统自动分配。Shard 数量影响计费，请合理配置。支持后续扩容，单 Shard 最大 256GB。（查看请求示例2） |
请求示例：
请求示例1：
{
"app_id": 5,
"attach_id": [
1300
],
"tables": [
{
"table_name": "ListTabl",
"zone_id": 2048
},
{
"table_name": "GenericTableDemo",
"zone_id": 2048
}
]
}
请求示例2： 指定分配2个shard
{
"app_id": 5,
"attach_id": [
1300
],
"alloc_resourc_mode": 2,
"tables": [
{
"table_name": "ListTabl",
"zone_id": 2048,
"shard_num": 2
},
{
"table_name": "GenericTableDemo",
"zone_id": 2048,
"shard_num": 2
}
]
}
返回参数：data 字段说明
| 参数名称 | 类型 | 说明 |
|---|---|---|
| check_result | number | 审核结果0： 没有异常， 无法自动审核的单据，没有自动审核，也是返回0，-1： 表示审核失败 |
| apply_list | 对象数组 | 生成的单据 |
| task_list | 对象数组 | 生成的任务 |
data对象中的apply_list数组元素对象字段说明
| 参数名称 | 类型 | 说明 |
|---|---|---|
| apply_id | number | 单据ID |
data对象中的task_list数组元素对象字段说明
| 参数名称 | 类型 | 说明 |
|---|---|---|
| task_id | number | 任务ID |
返回示例1 (自动审核, 生成事务成功):
{
"code": 0,
"request_id": "76a04fb1-25a0-4a79-b077-393c4b3ed625",
"data": {
"check_result": 0,
"app_id": 2,
"apply_list": [
{
"apply_id": 16830,
"apply_type_text": "表添加",
"zone_id": "1",
"app_id": 2,
"table_name": "Role",
"execute_status": 1,
"table_type": 0,
"tdr": "579",
"apply_type": 0
},
{
"apply_id": 16831,
"apply_type_text": "表添加",
"zone_id": "1",
"app_id": 2,
"table_name": "openid",
"execute_status": 1,
"table_type": 0,
"tdr": "579",
"apply_type": 0
}
],
"task_list": [
{
"apply_id": 16830,
"set_id": 1,
"app_id": 2,
"zone_id": "1",
"table_name": "Role",
"table_type": 0,
"table_maxnum": 0,
"fmt_type": "PROTO",
"task_id": 13723,
"result": 0,
"msg": "审核成功, 请查看生成的任务"
},
{
"apply_id": 16831,
"set_id": 1,
"app_id": 2,
"zone_id": "1",
"table_name": "openid",
"table_type": 0,
"table_maxnum": 0,
"fmt_type": "PROTO",
"task_id": 13724,
"result": 0,
"msg": "审核成功, 请查看生成的任务"
}
],
"apply_user": "v_jxlin",
"check_user": "v_jxlin",
"apply_time": "2022-09-16 12:35:15",
"check_time": "2022-09-16 12:35:15",
"msg": "提交申请成功, 请查看审核结果或任务执行状态",
"execute_task_user": "v_jxlin"
}
}
返回示例2 (需要审核, task_list为空数组):
{
"code": 0,
"request_id": "7aff0feb-cb6a-485a-912a-0e4adceef4b7",
"data": {
"check_result": 0, // 表示自动审核，没有出错。
"app_id": 2,
"apply_list": [
{
"apply_id": 16805,
"apply_type_text": "表添加",
"zone_id": "111",
"app_id": 2,
"table_name": "ListTableDemo",
"execute_status": 0,
"table_type": 1,
"tdr": "572",
"apply_type": 0
}
],
"task_list": [], // 因为是集群配置的是手动审核，所有任务为空
"apply_user": "v_jxlin",
"check_user": "v_jxlin",
"apply_time": "2022-09-15 11:19:26",
"check_time": "2022-09-15 11:19:26",
"msg": "提交申请成功, 请查看审核结果或任务执行状态",
"execute_task_user": "v_jxlin"
}
}
失败返回
{
"request_id": "e545fe17-ad91-4246-95cc-343be2ea69f0",
"code": 102,
"message": "存在冲突的表单据申请, 不能重复提交",
"debug_message": [
{
"apply_id": 20181,
"app_id": 5,
"zone_id": "555",
"table_name": "ItemAttri",
"apply_type": 0,
"execute_status": 0
}
]
}