请求地址

/v2/webservice/apply/check-add-table-apply

请求方法

Post

请求参数说明

参数名称	类型	是否必填	说明
apply_list	array	是
alloc_resourc_mode	number	否	资源分配模式，0: 自动，默认分配1个shard，自动查找机器1: 手动 , 指定分配到具体的svr和proxy2：按条件分配，例如：指定分配多少个shard版本要求1.16.0
~~alloc_zone_proxy~~	array	否	1.17.0版本移除此参数
memo	string	否	审核意见、备注
app_id	number	否

apply_list为对象数组，数组元素字段说明

参数名称	类型	是否必填	说明
apply_id	id	是	单据ID
auto_execute_task	boolean	否, 默认跟随集群配置	仅在集群配置为开启自动审核的时候，此配置生效
lock_svr	array	否	资源分配为手动的时候，必填
engine_parameters	string	否，默认使用推荐值	引擎参数
shard_num	number	否	alloc_resourc_mode=2时生效，为空或 0 则系统自动分配。Shard 数量影响计费，请合理配置。支持后续扩容，单 Shard 最大 256GB。

alloc_zone_proxy，apply_list.lock_svr参数说明资源分配方式为alloc_resourc_mode=1时，需要设置这些参数 apply_list.lock_svr为对象数组，数组元素字段说明

参数名称	类型	是否必填	说明
node_name	string	是	一对svr机器中master机器的唯一名称
shard_num	number	是	分配个数

alloc_zone_proxy为对象数组，数组元素字段说明

参数名称	类型	是否必填	说明
app_id	id	是
zone_id	id	是
lock_proxy	array	是	资源分配为手动的时候，必填

alloc_zone_proxy.lock_proxy为对象数组，数组元素字段说明 | 参数名称 | 类型 | 是否必填 | 说明 | | -------------------------- | ------------- | ---------- | --------------------------------------------------------------------------------------------- | | node_type | number 0, 1 | 是 | 0表示独占机器，1表示共享进程 | | node_name | string | 是 | 机器资源(node_type=0)，node_name填机器IP如果是共享进程(node_type=1)， node_name填进程ID | | proxy_num | number | 是 | 机器资源(node_type=0)，表示分配proxy个数，共享进程(node_type=1), 不需要填此参数 | | zone_expect_proxy_num | number | 是 | 期望分配proxy数 |

请求示例

自动分配资源

{
    "app_id": 2,
    "apply_list": [
        {
            "apply_id": 3,
            "auto_execute_task": true,
        }
    ]
}

手动分配资源

{
    "app_id": 2,
    "alloc_resourc_mode": 1,
    "apply_list": [
        {
            "apply_id": 3,
            "auto_execute_task": true,
            "lock_svr": [ { "node_name": "master_1", "shard_num": 2 },{ "node_name": "master_2", "shard_num": 2 } ],
            "engine_parameters": "bnum=100000#xmsiz=60000000#lnum=2#xikmsiz=26000000#kfapow=6#kmapow=6#vfapow=6#vmapow=6", 
        }
    ],
    "alloc_zone_proxy": [
        {
            "app_id": 2,
            "zone_id": 1,
            "lock_proxy": [
                { "node_name": "9.134.38.58", "proxy_num": 2, "node_type": 0 }
            ]
        }
    ]
}

按条件分配资源

{
    "app_id": 2,
    "alloc_resourc_mode": 2,
    "apply_list": [
        {
            "apply_id": 77243,
            "shard_num": 3,
            "auto_execute_task": true
        }
    ]
}

返回参数说明

通用参数 iwiki-document:inline_state

返回的data字段结构说明

参数名称	类型	说明
task_list	array	审核后生成的任务

data.task_list为对象数组，数组元素结构说明

参数名称	类型	说明
apply_id	number	单据ID
result	number， 0表示成功， -1表示失败	创建任务成功标识码
task_id	number	任务ID,

成功返回

{
    "code": 0,
    "request_id": "938213c0-fed8-4ab3-a236-9916e9f157bc",
    "data": {
        "task_list": [
            {
                "apply_id": 512,
                "set_id": 1,
                "app_id": 2,
                "zone_id": "3",
                "table_name": "table_list",
                "table_type": 0,
                "table_maxnum": 0,
                "fmt_type": "XML",
                "task_id": 491,
                "result": 0,
                "msg": "审核成功, 请查看生成的任务"
            }
        ]
    }
}

失败返回

{

}

审核加表申请