文档中心>TI-ONE 训练平台

TI-ONE 接口回调说明

最近更新时间:2022-12-16 14:48:41

我的收藏

1. 回调说明

创建模型服务、任务式建模、离线批处理请求中,如果用户设置了 CallbackUrl 参数,则通过回调的方式来返回创建结果,用户需要自行搭建可公网访问的 HTTP 或者 HTTPS 服务,并在创建任务时,将回调Url填写到 CallbackUrl 中。回调时,所有内容会放入 Body 中。Content-Type 为 application/json。

2. 回调 body 说明

2.1 回调 body 示例

{
"code":0,
"message":"SERVICE_ALL_AVAILABLE",
"id":"ms-rnpj4br8-1",
"appName":"tione",
"projectName":"ems",
"taskName":"CreateModelService",
"totalTime":103.395331817,
"responseTime":"2022-12-08 15:53:33"
}

2.2 回调参数说明

字段
类型
描述
code
Integer
任务状态码,0为成功,其它:失败;详见状态码说明。
message
String
详细信息。
id
String
内部 ID,区分资源标识。
appName
String
腾讯云应用名称,此处为“tione”。
projectName
String
模块名称,是一个枚举值:
ems:模型服务;
training:任务式建模。
predict:离线批处理
taskName
String
引起回调的任务名称,枚举值:
当 projectName=ems 时,可能的枚举值:
CreateModelService:创建模型服务

当 projectName=training 或者 predict 时,可能的枚举值:
Start:启动
Stop:停止
totalTime
Float
任务总耗时,单位秒。
responseTime
String
回调请求发出时间,格式形如:2022-12-08 15:53:33。

3. 回调 Response 说明

用户侧收到回调请求后,需要以JSON格式返回响应。

3.1 回调 Respons 示例

{
"code" : 0,
"message" : "success"
}

3.2 回调 Response 参数说明

参数名称
类型
描述
code
Integer
错误码,0为成功,其它值代表失败
message
String
失败原因说明

4. 回调状态码

4.1 模型服务回调状态码

数值
说明
10000
创建失败
10001
部分服务可用
10002
服务已被停止

4.2 任务式建模、离线批处理回调状态码

数值
说明
10001
任务创建失败
10002
任务运行失败
10003
任务超时或欠费被终止
10004
任务其它异常

5. 常见问题

回调最多尝试几次?

最多2次

过了很久都没有收到回调怎么办?

请确认回调服务是否正常,回调地址是否正确,且回调地址是否在公网下可以访问。
回调地址是 HTTPS 的,请确认证书经过合法 CA 机构认证。